cisco.dnac.network_device_maintenance_schedules_v1 module – Resource module for Network Device Maintenance Schedules V1

Note

This module is part of the cisco.dnac collection (version 6.27.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

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

To use it in a playbook, specify: cisco.dnac.network_device_maintenance_schedules_v1.

New in cisco.dnac 6.17.0

Synopsis

  • Manage operation create of the resource Network Device Maintenance Schedules V1.

  • API to create maintenance schedule for network devices. The state of network device can be queried using API `GET /dna/intent/api/v1/networkDevices`. The `managementState` attribute of the network device will be updated to `UNDER_MAINTENANCE` when the maintenance window starts.

Note

This module has a corresponding action plugin.

Requirements

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

  • dnacentersdk >= 2.4.9

  • python >= 3.5

Parameters

Parameter

Comments

description

string

A brief narrative describing the maintenance schedule.

dnac_debug

boolean

Flag for Cisco DNA Center SDK to enable debugging.

Choices:

  • false ← (default)

  • true

dnac_host

string / required

The Cisco DNA Center hostname.

dnac_password

string

The Cisco DNA Center password to authenticate.

dnac_port

integer

The Cisco DNA Center port.

Default: 443

dnac_username

aliases: user

string

The Cisco DNA Center username to authenticate.

Default: "admin"

dnac_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

  • false

  • true ← (default)

dnac_version

string

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

Default: "2.3.7.6"

maintenanceSchedule

dictionary

Network Device Maintenance Schedules’s maintenanceSchedule.

endTime

float

End time indicates the ending of the maintenance window in Unix epoch time in milliseconds.

recurrence

dictionary

Network Device Maintenance Schedules’s recurrence.

interval

integer

Interval for recurrence in days. The interval must be longer than the duration of the schedules. The maximum allowed interval is 365 days.

recurrenceEndTime

float

The end date for the recurrence in Unix epoch time in milliseconds. Recurrence end time should be greater than maintenance end date/time.

startTime

float

Start time indicates the beginning of the maintenance window in Unix epoch time in milliseconds.

networkDeviceIds

list / elements=string

List of network device ids. This field is applicable only during creation of schedules; for updates, it is read-only.

validate_response_schema

boolean

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

Choices:

  • false

  • true ← (default)

Notes

Note

  • SDK Method used are devices.Devices.create_maintenance_schedule_for_network_devices_v1,

  • Paths used are post /dna/intent/api/v1/networkDeviceMaintenanceSchedules,

  • 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 DNAC SDK

  • The parameters starting with dnac_ are used by the Cisco DNAC Python SDK to establish the connection

See Also

See also

Cisco DNA Center documentation for Devices CreateMaintenanceScheduleForNetworkDevicesV1

Complete reference of the CreateMaintenanceScheduleForNetworkDevicesV1 API.

Examples

- name: Create
  cisco.dnac.network_device_maintenance_schedules_v1:
    dnac_host: "{{dnac_host}}"
    dnac_username: "{{dnac_username}}"
    dnac_password: "{{dnac_password}}"
    dnac_verify: "{{dnac_verify}}"
    dnac_port: "{{dnac_port}}"
    dnac_version: "{{dnac_version}}"
    dnac_debug: "{{dnac_debug}}"
    state: present
    description: string
    maintenanceSchedule:
      endTime: 0
      recurrence:
        interval: 0
        recurrenceEndTime: 0
      startTime: 0
    networkDeviceIds:
    - string

Return Values

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

Key

Description

dnac_response

dictionary

A dictionary or list with the response returned by the Cisco DNAC Python SDK

Returned: always

Sample: {"response": {"taskId": "string", "url": "string"}, "version": "string"}

Authors

  • Rafael Campos (@racampos)