cisco.catalystcenter.network_device_maintenance_schedules_info module -- Information module for Network Device Maintenance Schedules

Note

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

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.network_device_maintenance_schedules_info.

New in cisco.catalystcenter 2.0.0

Synopsis

  • Get all Network Device Maintenance Schedules.

  • Get Network Device Maintenance Schedules by id.

  • API to retrieve the maintenance schedule information for the given id. - > This API retrieves a list of scheduled maintenance windows for network devices based on filter parameters. Each maintenance window is composed of a start schedule and end schedule, both of which have unique identifiers `startId` and `endId`. These identifiers can be used to fetch the status of the start schedule and end schedule using the `GET /dna/intent/api/v1/activities/{id}` API. Completed maintenance schedules are automatically removed from the system after two weeks.

Note

This module has a corresponding action plugin.

Requirements

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

  • catalystcentersdk >= 3.2.3.0.0

  • python >= 3.12

Parameters

Parameter

Comments

catalystcenter_debug

aliases: dnac_debug

boolean

Flag for Cisco Catalyst Center SDK to enable debugging.

Choices:

catalystcenter_host

aliases: dnac_host

string / required

The Cisco Catalyst Center hostname.

catalystcenter_password

aliases: dnac_password

string

The Cisco Catalyst Center password to authenticate.

catalystcenter_port

aliases: dnac_port, catalystcenter_api_port

integer

The Cisco Catalyst Center port.

Default: :ansible-option-default:`443`

catalystcenter_username

aliases: dnac_username, user

string

The Cisco Catalyst Center username to authenticate.

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

catalystcenter_verify

aliases: dnac_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

catalystcenter_version

aliases: dnac_version

string

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

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

headers

dictionary

Additional headers.

id

string

Id path parameter. Unique identifier for the maintenance schedule.

limit

integer

Limit query parameter. The number of records to show for this page.

networkDeviceIds

list / elements=string

NetworkDeviceIds query parameter. List of network device ids.

offset

integer

Offset query parameter. The first record to show for this page; the first record is numbered 1.

order

string

Order query parameter. Whether ascending or descending order should be used to sort the response.

sortBy

string

SortBy query parameter. A property within the response to sort by.

status

string

Status query parameter. The status of the maintenance schedule. Possible values are - `UPCOMING` The maintenance is scheduled and pending execution. - `IN_PROGRESS` The maintenance is currently in progress. - `COMPLETED` The maintenance window has been fully completed (For recurring maintenance, this indicates completion of the most recent occurrence). - `FAILED` Updating the device's management state was not successful. For more information on failure use `GET /dna/intent/api/v1/activities/{id}` API with `startId` and `endId` value.

validate_response_schema

boolean

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

Choices:

Notes

Note

  • SDK Method used are devices.Devices.retrieve_scheduled_maintenance_windows_for_network_devices, devices.Devices.retrieves_the_maintenance_schedule_information,

  • Paths used are get /dna/intent/api/v1/networkDeviceMaintenanceSchedules, get /dna/intent/api/v1/networkDeviceMaintenanceSchedules/{id},

  • Supports check_mode

  • The 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

  • Requires Python >= 3.10, matching the controller Python versions supported by the collection's minimum ansible-core version (see the collection README for the current ansible-core / Python compatibility range)

See Also

See also

Cisco Catalyst Center documentation for Devices RetrieveScheduledMaintenanceWindowsForNetworkDevices

Complete reference of the RetrieveScheduledMaintenanceWindowsForNetworkDevices API.

Cisco Catalyst Center documentation for Devices RetrievesTheMaintenanceScheduleInformation

Complete reference of the RetrievesTheMaintenanceScheduleInformation API.

Examples

---
- name: Get all Network Device Maintenance Schedules
  cisco.catalystcenter.network_device_maintenance_schedules_info:
    catalystcenter_host: "{{catalystcenter_host}}"
    catalystcenter_username: "{{catalystcenter_username}}"
    catalystcenter_password: "{{catalystcenter_password}}"
    catalystcenter_verify: "{{catalystcenter_verify}}"
    catalystcenter_port: "{{catalystcenter_port}}"
    catalystcenter_version: "{{catalystcenter_version}}"
    catalystcenter_debug: "{{catalystcenter_debug}}"
    headers: "{{my_headers | from_json}}"
    networkDeviceIds: []
    status: string
    limit: 0
    offset: 1
    sortBy: string
    order: asc
  register: result
- name: Get Network Device Maintenance Schedules by id
  cisco.catalystcenter.network_device_maintenance_schedules_info:
    catalystcenter_host: "{{catalystcenter_host}}"
    catalystcenter_username: "{{catalystcenter_username}}"
    catalystcenter_password: "{{catalystcenter_password}}"
    catalystcenter_verify: "{{catalystcenter_verify}}"
    catalystcenter_port: "{{catalystcenter_port}}"
    catalystcenter_version: "{{catalystcenter_version}}"
    catalystcenter_debug: "{{catalystcenter_debug}}"
    headers: "{{my_headers | from_json}}"
    id: string
  register: result

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 Catalyst Center Python SDK

Returned: always

Sample: :ansible-rv-sample-value:`{"response": {"description": "string", "id": "string", "maintenanceSchedule": {"endId": "string", "endTime": {}, "recurrence": {"interval": 0, "recurrenceEndTime": {}}, "startId": "string", "startTime": {}, "status": "string"}, "networkDeviceIds": ["string"]}, "version": "string"}`

Authors

  • Bryan Vargas (@bvargasre)