/ home / racampos / racampos.dnac / 0.0.1 / module / sda_control_plane_device

racampos.dnac.sda_control_plane_device (0.0.1) — module

Manage SdaControlPlaneDevice objects of Sda

| "added in version" 1.0 of racampos.dnac"

Authors: first last (@GitHubID)

preview | supported by community

This plugin has a corresponding action plugin.

Install collection

Install with ansible-galaxy collection install racampos.dnac:==0.0.1

Add to requirements.yml

  collections:
    - name: racampos.dnac
      version: 0.0.1

Description

Get control plane device from SDA Fabric.

Delete control plane device in SDA Fabric.

Add control plane device in SDA Fabric.

Requirements

dnacentersdk

Usage examples

Scanned by Steampunk Spotter

- name: get_control_plane_device
  cisco.dnac.sda_control_plane_device:
    state: query  # required
    device_ipaddress: SomeValue  # string, required
  register: query_result

Scanned by Steampunk Spotter

  
- name: delete_control_plane_device
  cisco.dnac.sda_control_plane_device:
    state: delete  # required
    device_ipaddress: SomeValue  # string, required

Scanned by Steampunk Spotter

  
- name: add_control_plane_device
  cisco.dnac.sda_control_plane_device:
    state: create  # required
    payload:  # required
    - deviceManagementIpAddress: SomeValue  # string
      siteNameHierarchy: SomeValue  # string

Inputs

    
payload:
    description:
    - An object to send in the Request body.
    - Required for state create.
    elements: dict
    suboptions:
      deviceManagementIpAddress:
        description:
        - It is the sda control plane device's deviceManagementIpAddress.
        type: str
      siteNameHierarchy:
        description:
        - It is the sda control plane device's siteNameHierarchy.
        type: str
    type: list

device_ipaddress:
    description:
    - Device IP Address.
    required: true
    type: str

Outputs

add_control_plane_device:
  contains: null
  description:
    description: Description, property of the response body.
    returned: success
    sample: <description>
    type: str
  executionStatusUrl:
    description: Execution Status Url, property of the response body.
    returned: success
    sample: <executionstatusurl>
    type: str
  returned: success
  status:
    description: Status, property of the response body.
    returned: success
    sample: <status>
    type: str
  type: dict
delete_control_plane_device:
  contains: null
  description:
    description: Description, property of the response body.
    returned: success
    sample: <description>
    type: str
  executionStatusUrl:
    description: Execution Status Url, property of the response body.
    returned: success
    sample: <executionstatusurl>
    type: str
  returned: success
  status:
    description: Status, property of the response body.
    returned: success
    sample: <status>
    type: str
  type: dict
get_control_plane_device:
  contains: null
  description:
    description: Description, property of the response body.
    returned: always
    sample: <description>
    type: str
  deviceManagementIpAddress:
    description: Device Management Ip Address, property of the response body.
    returned: always
    sample: <devicemanagementipaddress>
    type: str
  name:
    description: Name, property of the response body.
    returned: always
    sample: <name>
    type: str
  returned: always
  roles:
    description: Roles, property of the response body (list of strings).
    returned: always
    type: list
  siteHierarchy:
    description: Site Hierarchy, property of the response body.
    returned: always
    sample: <sitehierarchy>
    type: str
  status:
    description: Status, property of the response body.
    returned: always
    sample: <status>
    type: str
  type: dict

Install collection

Add to requirements.yml

Description

Requirements

Usage examples

Inputs

Outputs

See also