cisco.dnac.network_device_maintenance_schedules_id module -- Resource module for Network Device Maintenance Schedules Id

Note

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

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

New in cisco.dnac 6.17.0

Synopsis

  • This module represents an alias of the module network_device_maintenance_schedules_id_v1

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:

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: :ansible-option-default:`443`

dnac_username

aliases: user

string

The Cisco DNA Center username to authenticate.

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

dnac_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

dnac_version

string

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

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

id

string

Id path parameter. Unique identifier for the maintenance schedule.

maintenanceSchedule

dictionary

Network Device Maintenance Schedules Id'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 Id'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:

Notes

Note

  • SDK Method used are devices.Devices.delete_maintenance_schedule_v1, devices.Devices.updates_the_maintenance_schedule_information_v1,

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

  • It should be noted that this module is an alias of network_device_maintenance_schedules_id_v1

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

Complete reference of the DeleteMaintenanceScheduleV1 API.

Cisco DNA Center documentation for Devices UpdatesTheMaintenanceScheduleInformationV1

Complete reference of the UpdatesTheMaintenanceScheduleInformationV1 API.

Examples

- name: Update by id
  cisco.dnac.network_device_maintenance_schedules_id:
    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
    id: string
    maintenanceSchedule:
      endTime: 0
      recurrence:
        interval: 0
        recurrenceEndTime: 0
      startTime: 0
    networkDeviceIds:
    - string

- name: Delete by id
  cisco.dnac.network_device_maintenance_schedules_id:
    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: absent
    id: 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: :ansible-rv-sample-value:`{"response": {"taskId": "string", "url": "string"}, "version": "string"}`

Authors

  • Rafael Campos (@racampos)