cisco.dnac.sda_edge_device – Manage SdaEdgeDevice 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_edge_device.

New in version 1.0.0: of cisco.dnac

Synopsis

  • Delete edge device from SDA Fabric.

  • Get edge device from SDA Fabric.

  • Add edge 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 Choices/Defaults Comments
device_ipaddress
string / required
Device IP Address.
payload
list / elements=dictionary
An object to send in the Request body.
Required for state create.
deviceManagementIpAddress
string
It is the sda edge device's deviceManagementIpAddress.
siteNameHierarchy
string
It is the sda edge device's siteNameHierarchy.

See Also

See also

cisco.dnac.plugins.module_utils.definitions.sda_edge_device

The official documentation on the cisco.dnac.plugins.module_utils.definitions.sda_edge_device module.

SdaEdgeDevice reference

Complete reference of the SdaEdgeDevice object model.

SdaEdgeDevice reference

SDK reference.

Examples

- name: delete_edge_device
  cisco.dnac.sda_edge_device:
    state: delete  # required
    device_ipaddress: SomeValue  # string, required

- name: get_edge_device
  cisco.dnac.sda_edge_device:
    state: query  # required
    device_ipaddress: SomeValue  # string, required
  register: nm_get_edge_device

- name: add_edge_device
  cisco.dnac.sda_edge_device:
    state: create  # required
    payload:  # required
    - deviceManagementIpAddress: SomeValue  # string
      siteNameHierarchy: 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_edge_device


Authors

  • Rafael Campos (@racampos)