cisco.catalystcenter.pnp_network_devices_claim_create module -- Resource module for Pnp Network Devices Claim Create

Note

This module is part of the cisco.catalystcenter collection (version 2.11.0).

To install it, use: ansible-galaxy collection install cisco.catalystcenter. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: cisco.catalystcenter.pnp_network_devices_claim_create.

New in cisco.catalystcenter 2.11.0

Synopsis

  • Manage operation create of the resource Pnp Network Devices Claim Create. - > Claim a device in Plug & Play PnP. This triggers the PnP day-0 onboarding workflow based on the configuration payload provided.

Note

This module has a corresponding action plugin.

Requirements

The below requirements are needed on the host that executes this module.

  • catalystcentersdk >= 3.2.3.0.0

  • python >= 3.12

Parameters

Parameter

Comments

apZone

string

Logical partitioning of access point within a floor to map SSIDs and RF profiles.

cablingScheme

string

Cabling scheme (1A or 1B) of the switch stack. This describes how the stacking cables are connected between the switches.

catalystcenter_debug

aliases: dnac_debug

boolean

Flag for Cisco Catalyst Center SDK to enable debugging.

Choices:

catalystcenter_host

aliases: dnac_host

string / required

The Cisco Catalyst Center hostname.

catalystcenter_password

aliases: dnac_password

string

The Cisco Catalyst Center password to authenticate.

catalystcenter_port

aliases: dnac_port, catalystcenter_api_port

integer

The Cisco Catalyst Center port.

Default: :ansible-option-default:`443`

catalystcenter_username

aliases: dnac_username, user

string

The Cisco Catalyst Center username to authenticate.

Default: :ansible-option-default:`"admin"`

catalystcenter_verify

aliases: dnac_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

catalystcenter_version

aliases: dnac_version

string

Informs the SDK which version of Cisco Catalyst Center to use.

Default: :ansible-option-default:`"3.1.6.0"`

deviceType

string

Type of device being claimed. Different device types require different parameters.

gateway

dictionary

Pnp Network Devices Claim Create's gateway.

hostname

string

Hostname to be pushed to the device.

id

string

Id path parameter. Unique identifier of the device in PnP. This can be retrieved from the `id` field in the `GET /dna/intent/api/v1/pnpNetworkDevices` API.

imageInfo

dictionary

Details of the image to be installed on device. Image details can be fetched from the `GET /dna/intent/api/v1/images` API.

imageId

string

Unique identifier of the image in 'Software Image Management'.

removeInactive

boolean

Delete unused image .bin and .pkg files on the device.

Choices:

ipInterfaceName

string

IP interface name used for system communication.

licenseLevel

string

License level to be set on the switch stack.

prefix

integer

Prefix for wireless controller (mandatory for ipv6).

pushDeviceIdCertificate

boolean

Apply PKCS12 certificate to device.

Choices:

rfProfile

string

Radio-frequency (RF) profile for access point.

sensorProfile

string

Sensor profile.

siteId

string

Unique identifier of the site to claim the device to. A list of sites can be fetched from the `GET /dna/intent/api/v1/sites` API.

staticIpAddress

dictionary

Pnp Network Devices Claim Create's staticIpAddress.

subnetMask

string

Subnet mask for wireless controller.

svlConfig

dictionary

Configuration details to form an SVL.

domain

integer

SVL domain number.

svlMembers

list / elements=dictionary

List of member switches in the SVL.

dictionary

Link between connected interfaces.

string

Local interface name.

string

Remote interface.

role

string

Role of a member in an SVL.

serialNumber

string

Serial number of the member switch.

list / elements=dictionary

List of links between member switches in the SVL.

string

Local interface name.

string

Remote interface.

topOfStackSerialNumber

string

Serial number of the switch to be designated as the top-of-stack switch.

validate_response_schema

boolean

Flag for Cisco Catalyst Center SDK to enable the validation of request bodies against a JSON schema.

Choices:

vlanId

integer

VLAN ID for wireless controller. Creates and sets the specific port as trunk. Must be a value in 1-1001 or 1006-4094.

Notes

Note

  • SDK Method used are device_onboarding_pnp.DeviceOnboardingPnp.claim_a_device_in_pnp,

  • Paths used are post /dna/intent/api/v1/pnpNetworkDevices/{id}/claim,

  • Does not support check_mode

  • The plugin runs on the control node and does not use any ansible connection plugins,

  • but instead uses the embedded connection manager from Cisco CATALYST SDK

  • Requires Python >= 3.10, matching the controller Python versions supported by the collection's minimum ansible-core version (see the collection README for the current ansible-core / Python compatibility range)

See Also

See also

Cisco Catalyst Center documentation for Device Onboarding (PnP) ClaimADeviceInPnP

Complete reference of the ClaimADeviceInPnP API.

Examples

---
- name: Create
  cisco.catalystcenter.pnp_network_devices_claim_create:
    catalystcenter_host: "{{catalystcenter_host}}"
    catalystcenter_username: "{{catalystcenter_username}}"
    catalystcenter_password: "{{catalystcenter_password}}"
    catalystcenter_verify: "{{catalystcenter_verify}}"
    catalystcenter_port: "{{catalystcenter_port}}"
    catalystcenter_version: "{{catalystcenter_version}}"
    catalystcenter_debug: "{{catalystcenter_debug}}"
    apZone: string
    cablingScheme: string
    deviceType: string
    gateway: {}
    hostname: string
    id: string
    imageInfo:
      imageId: string
      removeInactive: true
    ipInterfaceName: string
    licenseLevel: string
    prefix: 0
    pushDeviceIdCertificate: true
    rfProfile: string
    sensorProfile: string
    siteId: string
    staticIpAddress: {}
    subnetMask: string
    svlConfig:
      domain: 0
      svlMembers:
        - dadLink: {}
          role: string
          serialNumber: string
          svlLinks:
            - localInterface: string
              remoteInterface: string
    topOfStackSerialNumber: string
    vlanId: 0

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

catalystcenter_response

dictionary

A dictionary or list with the response returned by the Cisco Catalyst Center Python SDK

Returned: always

Sample: :ansible-rv-sample-value:`{"response": {"taskId": "string", "url": "string"}, "version": "string"}`

Authors

  • Bryan Vargas (@bvargasre)