/ home / racampos / racampos.dnac / 0.0.1 / module / sda_host_onboarding_user_device

racampos.dnac.sda_host_onboarding_user_device (0.0.1) — module

Manage SdaHostOnboardingUserDevice 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 Port assignment for user device in SDA Fabric.

Delete Port assignment for user device in SDA Fabric.

Add Port assignment for user device in SDA Fabric.

Requirements

dnacentersdk

Usage examples

Scanned by Steampunk Spotter

- name: get_port_assignment_for_user_device
  cisco.dnac.sda_host_onboarding_user_device:
    state: query  # required
    device_ip: SomeValue  # string, required
    interface_name: SomeValue  # string, required
  register: query_result

Scanned by Steampunk Spotter

  
- name: delete_port_assignment_for_user_device
  cisco.dnac.sda_host_onboarding_user_device:
    state: delete  # required
    device_ip: SomeValue  # string, required
    interface_name: SomeValue  # string, required

Scanned by Steampunk Spotter

  
- name: add_port_assignment_for_user_device
  cisco.dnac.sda_host_onboarding_user_device:
    state: create  # required
    payload:  # required
    - siteNameHierarchy: SomeValue  # string
      deviceManagementIpAddress: SomeValue  # string
      interfaceName: SomeValue  # string
      dataIpAddressPoolName: SomeValue  # string
      voiceIpAddressPoolName: SomeValue  # string
      authenticateTemplateName: SomeValue  # string

Inputs

    
payload:
    description:
    - An object to send in the Request body.
    - Required for state create.
    elements: dict
    suboptions:
      authenticateTemplateName:
        description:
        - It is the sda host onboarding user device's authenticateTemplateName.
        type: str
      dataIpAddressPoolName:
        description:
        - It is the sda host onboarding user device's dataIpAddressPoolName.
        type: str
      deviceManagementIpAddress:
        description:
        - It is the sda host onboarding user device's deviceManagementIpAddress.
        type: str
      interfaceName:
        description:
        - It is the sda host onboarding user device's interfaceName.
        type: str
      siteNameHierarchy:
        description:
        - It is the sda host onboarding user device's siteNameHierarchy.
        type: str
      voiceIpAddressPoolName:
        description:
        - It is the sda host onboarding user device's voiceIpAddressPoolName.
        type: str
    type: list

device_ip:
    description:
    - Device-ip query parameter.
    required: true
    type: str

interface_name:
    description:
    - InterfaceName query parameter.
    required: true
    type: str

Outputs

add_port_assignment_for_user_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_port_assignment_for_user_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_port_assignment_for_user_device:
  authenticateTemplateName:
    description: Authenticate Template Name, property of the response body.
    returned: always
    sample: <authenticatetemplatename>
    type: str
  contains: null
  dataIpAddressPoolName:
    description: Data Ip Address Pool Name, property of the response body.
    returned: always
    sample: <dataipaddresspoolname>
    type: str
  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
  interfaceName:
    description: Interface Name, property of the response body.
    returned: always
    sample: <interfacename>
    type: str
  returned: always
  scalableGroupName:
    description: Scalable Group Name, property of the response body.
    returned: always
    sample: <scalablegroupname>
    type: str
  siteNameHierarchy:
    description: Site Name Hierarchy, property of the response body.
    returned: always
    sample: <sitenamehierarchy>
    type: str
  status:
    description: Status, property of the response body.
    returned: always
    sample: <status>
    type: str
  type: dict
  voiceIpAddressPoolName:
    description: Voice Ip Address Pool Name, property of the response body.
    returned: always
    sample: <voiceipaddresspoolname>
    type: str

Install collection

Add to requirements.yml

Description

Requirements

Usage examples

Inputs

Outputs

See also