cisco.catalystcenter.pnp_device_claim_to_site module -- Resource module for Pnp Device Claim To Site

Note

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

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_device_claim_to_site.

New in cisco.catalystcenter 3.1.0

Synopsis

  • Manage operation create of the resource Pnp Device Claim To Site. - > Claim a device based on Catalyst Center Site-based design process. Some required parameters differ based on device platform.

Note

This module has a corresponding action plugin.

Requirements

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

  • catalystcentersdk >= 3.1.6.0.0

  • python >= 3.12

Parameters

Parameter

Comments

catalystcenter_debug

boolean

Flag for Cisco Catalyst Center SDK to enable debugging.

Choices:

catalystcenter_host

string / required

The Cisco Catalyst Center hostname.

catalystcenter_password

string

The Cisco Catalyst Center password to authenticate.

catalystcenter_port

integer

The Cisco Catalyst Center port.

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

catalystcenter_username

string

The Cisco Catalyst Center username to authenticate.

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

catalystcenter_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

catalystcenter_version

string

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

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

configInfo

dictionary

added in cisco.catalystcenter 4.2.0

Pnp Device Claim To Site's configInfo.

configId

string

Config Id.

configParameters

list / elements=dictionary

Pnp Device Claim To Site's configParameters.

key

string

Key.

value

string

Value.

deviceId

string

Device Id.

gateway

string

added in cisco.catalystcenter 6.4.0

For CatalystWLC/MobilityExpress.

hostname

string

added in cisco.catalystcenter 4.2.0

Hostname to configure on Device.

imageInfo

dictionary

added in cisco.catalystcenter 4.2.0

Pnp Device Claim To Site's imageInfo.

imageId

string

Image Id.

skip

boolean

Skip.

Choices:

ipInterfaceName

string

added in cisco.catalystcenter 6.4.0

For Catalyst 9800 WLC.

rfProfile

string

added in cisco.catalystcenter 6.1.0

For Access Points.

sensorProfile

string

For Sensors.

siteId

string

Site Id.

staticIP

string

added in cisco.catalystcenter 6.4.0

For CatalystWLC/MobilityExpress.

subnetMask

string

For CatalystWLC/MobilityExpress.

type

string

Type.

validate_response_schema

boolean

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

Choices:

vlanId

string

added in cisco.catalystcenter 6.4.0

For Catalyst 9800 WLC.

Notes

Note

  • SDK Method used are device_onboarding_pnp.DeviceOnboardingPnp.claim_a_device_to_a_site,

  • Paths used are post /dna/intent/api/v1/onboarding/pnp-device/site-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

See Also

See also

Cisco DNA Center documentation for Device Onboarding (PnP) ClaimADeviceToASite

Complete reference of the ClaimADeviceToASite API.

Examples

---
- name: Create
  cisco.catalystcenter.pnp_device_claim_to_site:
    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}}"
    configInfo:
      configId: string
      configParameters:
        - key: string
          value: string
    deviceId: string
    gateway: string
    hostname: string
    imageInfo:
      imageId: string
      skip: true
    ipInterfaceName: string
    rfProfile: string
    sensorProfile: string
    siteId: string
    staticIP: string
    subnetMask: string
    type: string
    vlanId: string

Return Values

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

Key

Description

dnac_response

dictionary

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

Returned: always

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

Authors

  • Rafael Campos (@racampos)