cisco.catalystcenter.network_device_maintenance_schedules_count_v1_info module -- Information module for Network Device Maintenance Schedules Count 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.network_device_maintenance_schedules_count_v1_info.

New in cisco.catalystcenter 6.17.0

Synopsis

  • Get all Network Device Maintenance Schedules Count V1.

  • Retrieve the total count of all scheduled maintenance windows for network devices.

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"`

headers

dictionary

Additional headers.

networkDeviceIds

string

NetworkDeviceIds query parameter. List of network device ids.

status

string

Status query parameter. The status of the maintenance schedule. Possible values are UPCOMING, IN_PROGRESS, COMPLETED, FAILED. Refer features for more details.

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_the_total_number_of_scheduled_maintenance_windows_v1,

  • Paths used are get /dna/intent/api/v1/networkDeviceMaintenanceSchedules/count,

  • Supports 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 Devices RetrieveTheTotalNumberOfScheduledMaintenanceWindowsV1

Complete reference of the RetrieveTheTotalNumberOfScheduledMaintenanceWindowsV1 API.

Examples

- name: Get all Network Device Maintenance Schedules Count V1
  cisco.catalystcenter.network_device_maintenance_schedules_count_v1_info:
    _host: "{{ _host }}"
    _username: "{{ _username }}"
    _password: "{{ _password }}"
    _verify: "{{ _verify }}"
    _api_port: "{{ _api_port }}"
    _version: "{{ _version }}"
    _debug: "{{ _debug }}"
    headers: "{{my_headers | from_json}}"
    networkDeviceIds: string
    status: 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 DNAC Python SDK

Returned: always

Sample: :ansible-rv-sample-value:`{"response": {"count": 0}, "version": "string"}`

Authors

  • Rafael Campos (@racampos)