/ home / cisco / cisco.dnac / 6.13.3 / module / pnp_device_claim_to_site

cisco.dnac.pnp_device_claim_to_site (6.13.3) — module

Resource module for Pnp Device Claim To Site

| "added in version" 3.1.0 of cisco.dnac"

Authors: Rafael Campos (@racampos)

This plugin has a corresponding action plugin.

Install collection

Install with ansible-galaxy collection install cisco.dnac:==6.13.3

Add to requirements.yml

  collections:
    - name: cisco.dnac
      version: 6.13.3

Description

Manage operation create of the resource Pnp Device Claim To Site.

Claim a device based on DNA-C Site-based design process. Some required parameters differ based on device platform.

Requirements

dnacentersdk >= 2.6.0
python >= 3.9

Usage examples

Scanned by Steampunk Spotter

- name: Create
  cisco.dnac.pnp_device_claim_to_site:
    dnac_host: "{{dnac_host}}"
    dnac_username: "{{dnac_username}}"
    dnac_password: "{{dnac_password}}"
    dnac_verify: "{{dnac_verify}}"
    dnac_port: "{{dnac_port}}"
    dnac_version: "{{dnac_version}}"
    dnac_debug: "{{dnac_debug}}"
    configInfo:
    - configId: string
      configParameters:
        key: string
        value: string
    deviceId: string
    gateway: string
    imageInfo:
      imageId: string
      skip: true
    interfaceName: string
    rfProfile: string
    sensorProfile: string
    siteId: string
    staticIP: string
    subnetMask: string
    type: string
    vlanID: string

Inputs

    
type:
    description: Type.
    type: str

siteId:
    description: Site Id.
    type: str

vlanID:
    description: For Catalyst 9800 WLC.
    type: str

gateway:
    description: For CatalystWLC/MobilityExpress.
    type: str
    version_added: 6.4.0
    version_added_collection: cisco.dnac

deviceId:
    description: Device Id.
    type: str

staticIP:
    description: For CatalystWLC/MobilityExpress.
    type: str
    version_added: 6.4.0
    version_added_collection: cisco.dnac

dnac_host:
    description:
    - The Cisco DNA Center hostname.
    required: true
    type: str

dnac_port:
    default: 443
    description:
    - The Cisco DNA Center port.
    type: int

imageInfo:
    description: Pnp Device Claim To Site's imageInfo.
    suboptions:
      imageId:
        description: Image Id.
        type: str
      skip:
        description: Skip.
        type: bool
    type: dict
    version_added: 4.2.0
    version_added_collection: cisco.dnac

rfProfile:
    description: For Access Points.
    type: str
    version_added: 6.1.0
    version_added_collection: cisco.dnac

configInfo:
    description: Pnp Device Claim To Site's configInfo.
    elements: dict
    suboptions:
      configId:
        description: Config Id.
        type: str
      configParameters:
        description: Pnp Device Claim To Site's configParameters.
        suboptions:
          key:
            description: Key.
            type: str
          value:
            description: Value.
            type: str
        type: dict
    type: list
    version_added: 4.2.0
    version_added_collection: cisco.dnac

dnac_debug:
    default: false
    description:
    - Flag for Cisco DNA Center SDK to enable debugging.
    type: bool

subnetMask:
    description: For CatalystWLC/MobilityExpress.
    type: str

dnac_verify:
    default: true
    description:
    - Flag to enable or disable SSL certificate verification.
    type: bool

dnac_version:
    default: 2.3.5.3
    description:
    - Informs the SDK which version of Cisco DNA Center to use.
    type: str

dnac_password:
    description:
    - The Cisco DNA Center password to authenticate.
    type: str

dnac_username:
    aliases:
    - user
    default: admin
    description:
    - The Cisco DNA Center username to authenticate.
    type: str

interfaceName:
    description: For Catalyst 9800 WLC.
    type: str

sensorProfile:
    description: For Sensors.
    type: str

validate_response_schema:
    default: true
    description:
    - Flag for Cisco DNA Center SDK to enable the validation of request bodies against
      a JSON schema.
    type: bool

Outputs

dnac_response:
  description: A dictionary or list with the response returned by the Cisco DNAC Python
    SDK
  returned: always
  sample: "{\n  \"response\": \"string\",\n  \"version\": \"string\"\n}\n"
  type: dict