cisco.dnac.sda_host_onboarding_user_device – Manage SdaHostOnboardingUserDevice objects of Sda¶

Note

This plugin is part of the cisco.dnac collection (version 2.0.7).

To install it use: ansible-galaxy collection install cisco.dnac.

To use it in a playbook, specify: cisco.dnac.sda_host_onboarding_user_device.

New in version 1.0.0: of cisco.dnac

Synopsis
Requirements
Parameters
See Also
Examples
Return Values

Synopsis ¶

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.

Note

This module has a corresponding action plugin.

Requirements ¶

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

dnacentersdk

Parameters ¶

Parameter		Comments
device_ip string / required		Device-ip query parameter.
interface_name string / required		InterfaceName query parameter.
payload list / elements=dictionary		An object to send in the Request body. Required for state create.
	authenticateTemplateName string	It is the sda host onboarding user device's authenticateTemplateName.
	dataIpAddressPoolName string	It is the sda host onboarding user device's dataIpAddressPoolName.
	deviceManagementIpAddress string	It is the sda host onboarding user device's deviceManagementIpAddress.
	interfaceName string	It is the sda host onboarding user device's interfaceName.
	siteNameHierarchy string	It is the sda host onboarding user device's siteNameHierarchy.
	voiceIpAddressPoolName string	It is the sda host onboarding user device's voiceIpAddressPoolName.

Examples ¶

- 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: nm_get_port_assignment_for_user_device

- 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

- 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

Return Values ¶

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

Key	Returned	Description
dnac_response dictionary	always	A dictionary with the response returned by the DNA Center Python SDK Sample: {'response': 29, 'version': '1.0'}
missing_params list / elements=string	when the function request schema is not satisfied	Provided arguments do not comply with the schema of the DNA Center Python SDK function
sdk_function string	always	The DNA Center SDK function used to execute the task Sample: sda.add_port_assignment_for_user_device

Authors¶

Rafael Campos (@racampos)

cisco.dnac.sda_host_onboarding_user_device – Manage SdaHostOnboardingUserDevice objects of Sda¶

Synopsis¶

Requirements¶

Parameters¶

See Also¶

Examples¶

Return Values¶