cisco.catalystcenter.pnp_device_reset_v1 module -- Resource module for Pnp Device Reset 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.pnp_device_reset_v1.

New in cisco.catalystcenter 3.1.0

Synopsis

  • Manage operation create of the resource Pnp Device Reset V1.

  • Recovers a device from a Workflow Execution Error state.

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:

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

_version

string

Informs the SDK which version of Cisco CATALYST Center to use.

Default: :ansible-option-default:`"2.3.7.6"`

deviceResetList

list / elements=dictionary

Pnp Device Reset's deviceResetList.

configList

list / elements=dictionary

Pnp Device Reset's configList.

configId

string

Pnp Device Reset's configId.

configParameters

list / elements=dictionary

Pnp Device Reset's configParameters.

key

string

Pnp Device Reset's key.

value

string

Pnp Device Reset's value.

deviceId

string

Pnp Device Reset's deviceId.

licenseLevel

string

Pnp Device Reset's licenseLevel.

licenseType

string

Pnp Device Reset's licenseType.

topOfStackSerialNumber

string

Pnp Device Reset's topOfStackSerialNumber.

projectId

string

Pnp Device Reset's projectId.

validate_response_schema

boolean

Flag for Cisco CATALYST Center SDK to enable the validation of request bodies against a JSON schema.

Choices:

workflowId

string

Pnp Device Reset's workflowId.

Notes

Note

  • SDK Method used are device_onboarding_pnp.DeviceOnboardingPnp.reset_device_v1,

  • Paths used are post /dna/intent/api/v1/onboarding/pnp-device/reset,

  • 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 Device Onboarding (PnP) ResetDeviceV1

Complete reference of the ResetDeviceV1 API.

Examples

- name: Create
  cisco.catalystcenter.pnp_device_reset_v1:
    _host: "{{ _host }}"
    _username: "{{ _username }}"
    _password: "{{ _password }}"
    _verify: "{{ _verify }}"
    _api_port: "{{ _api_port }}"
    _version: "{{ _version }}"
    _debug: "{{ _debug }}"
    deviceResetList:
      - configList:
          - configId: string
            configParameters:
              - key: string
                value: string
        deviceId: string
        licenseLevel: string
        licenseType: string
        topOfStackSerialNumber: string
    projectId: string
    workflowId: 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:`{"jsonArrayResponse": [{}], "jsonResponse": {}, "message": "string", "statusCode": 0}`

Authors

  • Rafael Campos (@racampos)