cisco.catalystcenter.sda_provision_devices_v1 module -- Resource module for Sda Provision Devices V1

Note

This module is part of the cisco.catalystcenter collection (version 2.1.4).

To install it, use: ansible-galaxy collection install cisco.catalystcenter. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: cisco.catalystcenter.sda_provision_devices_v1.

New in cisco.catalystcenter 6.14.0

Synopsis

• Manage operations create, update and delete of the resource Sda Provision Devices V1.

• Provisions network devices to respective Sites based on user input.

• Delete provisioned devices based on query parameters.

• Deletes provisioned device based on Id.

• Re-provisions network devices to the site based on the user input.

Note

This module has a corresponding action plugin.

Requirements

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

• catalystcentersdk >= 2.3.7.9

• python >= 3.5

Parameters

Parameter	Comments
_api_port integer	The Cisco CATALYST Center port. Default: :ansible-option-default:`443`
_debug boolean	Flag for Cisco CATALYST Center SDK to enable debugging. Choices: :ansible-option-choices-entry-default:`false` ← (default) :ansible-option-choices-entry:`true`
_host string / required	The Cisco CATALYST Center hostname.
_password string	The Cisco CATALYST Center password to authenticate.
_username aliases: user string	The Cisco CATALYST Center username to authenticate. Default: :ansible-option-default:`"admin"`
_verify boolean	Flag to enable or disable SSL certificate verification. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)
_version string	Informs the SDK which version of Cisco CATALYST Center to use. Default: :ansible-option-default:`"2.3.7.6"`
cleanUpConfig boolean	CleanUpConfig query parameter. Enable/disable configuration cleanup for the device(s). Defaults to true. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
id string	Id path parameter. ID of the provisioned device.
networkDeviceId string	NetworkDeviceId query parameter. ID of the network device.
payload list / elements=dictionary	Sda Provision Devices's payload.
networkDeviceId string	ID of network device to be provisioned.
siteId string	ID of the site this network device needs to be provisioned.
siteId string	SiteId query parameter. ID of the site hierarchy.
validate_response_schema boolean	Flag for Cisco CATALYST Center SDK to enable the validation of request bodies against a JSON schema. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)

Notes

Note

• SDK Method used are sda.Sda.delete_provisioned_device_by_id_v1, sda.Sda.provision_devices_v1, sda.Sda.re_provision_devices_v1,

• Paths used are post /dna/intent/api/v1/sda/provisionDevices, delete /dna/intent/api/v1/sda/provisionDevices, delete /dna/intent/api/v1/sda/provisionDevices/{id}, put /dna/intent/api/v1/sda/provisionDevices,

• Does not support check_mode

• The plugin runs on the control node and does not use any ansible connection plugins, but instead the embedded connection manager from Cisco CATALYST SDK

• The parameters starting with catalystCenter_ are used by the Cisco CATALYST Python SDK to establish the connection

See Also

See also

Cisco DNA Center documentation for SDA ProvisionDevicesV1

Complete reference of the ProvisionDevicesV1 API.

Cisco DNA Center documentation for SDA DeleteProvisionedDeviceByIdV1

Complete reference of the DeleteProvisionedDeviceByIdV1 API.

Cisco DNA Center documentation for SDA DeleteProvisionedDevicesV1

Complete reference of the DeleteProvisionedDevicesV1 API.

Cisco DNA Center documentation for SDA ReProvisionDevicesV1

Complete reference of the ReProvisionDevicesV1 API.

Examples

- name: Delete all
  cisco.catalystcenter.sda_provision_devices_v1:
    _host: "{{ _host }}"
    _username: "{{ _username }}"
    _password: "{{ _password }}"
    _verify: "{{ _verify }}"
    _api_port: "{{ _api_port }}"
    _version: "{{ _version }}"
    _debug: "{{ _debug }}"
    state: absent
    cleanUpConfig: true
    networkDeviceId: string
    siteId: string
- name: Create
  cisco.catalystcenter.sda_provision_devices_v1:
    _host: "{{ _host }}"
    _username: "{{ _username }}"
    _password: "{{ _password }}"
    _verify: "{{ _verify }}"
    _api_port: "{{ _api_port }}"
    _version: "{{ _version }}"
    _debug: "{{ _debug }}"
    state: present
    payload:
      - networkDeviceId: string
        siteId: string
- name: Update all
  cisco.catalystcenter.sda_provision_devices_v1:
    _host: "{{ _host }}"
    _username: "{{ _username }}"
    _password: "{{ _password }}"
    _verify: "{{ _verify }}"
    _api_port: "{{ _api_port }}"
    _version: "{{ _version }}"
    _debug: "{{ _debug }}"
    state: present
    payload:
      - id: string
        networkDeviceId: string
        siteId: string
- name: Delete by id
  cisco.catalystcenter.sda_provision_devices_v1:
    _host: "{{ _host }}"
    _username: "{{ _username }}"
    _password: "{{ _password }}"
    _verify: "{{ _verify }}"
    _api_port: "{{ _api_port }}"
    _version: "{{ _version }}"
    _debug: "{{ _debug }}"
    state: absent
    cleanUpConfig: true
    id: string

Return Values

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

Key	Description
catalystcenter_response dictionary	A dictionary or list with the response returned by the Cisco DNAC Python SDK Returned: always Sample: :ansible-rv-sample-value:`{"response": {"taskId": "string", "url": "string"}, "version": "string"}`

Authors

• Rafael Campos (@racampos)

Collection links

Issue Tracker Repository (Sources)