cisco.catalystcenter.eox_status_device_info module -- Information module for Eox Status Device
Note
This module is part of the cisco.catalystcenter collection (version 2.2.2).
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.eox_status_device_info.
New in cisco.catalystcenter 3.1.0
Synopsis
Get all Eox Status Device.
Get Eox Status Device by id.
Retrieves EoX details for a device.
Retrieves EoX status for all devices in the network.
Note
This module has a corresponding action plugin.
Requirements
The below requirements are needed on the host that executes this module.
catalystcentersdk >= 3.1.3.0.0
python >= 3.5
Parameters
Parameter |
Comments |
|---|---|
The Cisco Catalyst Center port. Default: :ansible-option-default:`443` |
|
Flag for Cisco Catalyst Center SDK to enable debugging. Choices: |
|
The Cisco Catalyst Center hostname. |
|
The Cisco Catalyst Center password to authenticate. |
|
The Cisco Catalyst Center username to authenticate. Default: :ansible-option-default:`"admin"` |
|
Flag to enable or disable SSL certificate verification. Choices: |
|
Informs the SDK which version of Cisco Catalyst Center to use. Default: :ansible-option-default:`"2.3.7.6"` |
|
DeviceId path parameter. Device instance UUID. |
|
Additional headers. |
|
Limit query parameter. The number of records to show for this page. Default is 500 if not specified. Maximum allowed limit is 500. |
|
Offset query parameter. The first record to show for this page, the first record is numbered 1. |
|
Flag for Cisco Catalyst Center SDK to enable the validation of request bodies against a JSON schema. Choices: |
Notes
Note
SDK Method used are eox.Eox.get_eox_details_per_device, eox.Eox.get_eox_status_for_all_devices,
Paths used are get /dna/intent/api/v1/eox-status/device, get /dna/intent/api/v1/eox-status/device/{deviceId},
Supports
check_modeThe plugin runs on the control node and does not use any ansible connection plugins,
but instead uses the embedded connection manager from Cisco CATALYST SDK
See Also
See also
- Cisco DNA Center documentation for EoX GetEoXDetailsPerDevice
Complete reference of the GetEoXDetailsPerDevice API.
- Cisco DNA Center documentation for EoX GetEoXStatusForAllDevices
Complete reference of the GetEoXStatusForAllDevices API.
Examples
---
- name: Get all Eox Status Device
cisco.catalystcenter.eox_status_device_info:
catalystcenter_host: "{{catalystcenter_host}}"
catalystcenter_username: "{{catalystcenter_username}}"
catalystcenter_password: "{{catalystcenter_password}}"
catalystcenter_verify: "{{catalystcenter_verify}}"
catalystcenter_api_port: "{{catalystcenter_api_port}}"
catalystcenter_version: "{{catalystcenter_version}}"
catalystcenter_debug: "{{catalystcenter_debug}}"
headers: "{{my_headers | from_json}}"
limit: 0
offset: 0
register: result
- name: Get Eox Status Device by id
cisco.catalystcenter.eox_status_device_info:
catalystcenter_host: "{{catalystcenter_host}}"
catalystcenter_username: "{{catalystcenter_username}}"
catalystcenter_password: "{{catalystcenter_password}}"
catalystcenter_verify: "{{catalystcenter_verify}}"
catalystcenter_api_port: "{{catalystcenter_api_port}}"
catalystcenter_version: "{{catalystcenter_version}}"
catalystcenter_debug: "{{catalystcenter_debug}}"
headers: "{{my_headers | from_json}}"
deviceId: string
register: result
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
A dictionary or list with the response returned by the Cisco CATALYST Python SDK Returned: always |