/ home / cisco / cisco.dnac / 2.0.7 / module / sda_host_onboarding_access_point

cisco.dnac.sda_host_onboarding_access_point (2.0.7) — module

Manage SdaHostOnboardingAccessPoint objects of Sda

| "added in version" 1.0.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:==2.0.7

Add to requirements.yml

  collections:
    - name: cisco.dnac
      version: 2.0.7

Description

Delete Port assignment for access point in SDA Fabric.

Get Port assignment for access point in SDA Fabric.

Add Port assignment for access point in SDA Fabric.

Requirements

dnacentersdk

Usage examples

Scanned by Steampunk Spotter

- name: delete_port_assignment_for_access_point
  cisco.dnac.sda_host_onboarding_access_point:
    state: delete  # required
    device_ip: SomeValue  # string, required
    interface_name: SomeValue  # string, required

Scanned by Steampunk Spotter

- name: get_port_assignment_for_access_point
  cisco.dnac.sda_host_onboarding_access_point:
    state: query  # required
    device_ip: SomeValue  # string, required
    interface_name: SomeValue  # string, required
  register: nm_get_port_assignment_for_access_point

Scanned by Steampunk Spotter

- name: add_port_assignment_for_access_point
  cisco.dnac.sda_host_onboarding_access_point:
    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 access point's authenticateTemplateName.
        type: str
      dataIpAddressPoolName:
        description:
        - It is the sda host onboarding access point's dataIpAddressPoolName.
        type: str
      deviceManagementIpAddress:
        description:
        - It is the sda host onboarding access point's deviceManagementIpAddress.
        type: str
      interfaceName:
        description:
        - It is the sda host onboarding access point's interfaceName.
        type: str
      siteNameHierarchy:
        description:
        - It is the sda host onboarding access point's siteNameHierarchy.
        type: str
      voiceIpAddressPoolName:
        description:
        - It is the sda host onboarding access point'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

dnac_response:
  description: A dictionary with the response returned by the DNA Center Python SDK
  returned: always
  sample:
    response: 29
    version: '1.0'
  type: dict
missing_params:
  description: Provided arguments do not comply with the schema of the DNA Center
    Python SDK function
  returned: when the function request schema is not satisfied
  sample: null
  type: list
sdk_function:
  description: The DNA Center SDK function used to execute the task
  returned: always
  sample: sda.add_port_assignment_for_access_point
  type: str

Install collection

Add to requirements.yml

Description

Requirements

Usage examples

Inputs

Outputs

See also