aci_maintenance_policy
Manage maintenance policies on Cisco ACI
Collection: cisco.aci
Full Name: cisco.aci.aci_maintenance_policy
Synopsis
Manage maintenance policies on Cisco ACI
Parameters
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| admin_state | string | The administrative state of the executable policies. Will trigger an immediate upgrade for nodes if C(admin_state) is set to triggered. The APIC defaults to C(untriggered) when unset during creation. | ||
| annotation | string | orchestrator:ansible | User-defined string for annotating an object. If the value is not specified in the task, the value of environment variable C(ACI_ANNOTATION) will be used instead. If the value is not specified in the task and environment variable C(ACI_ANNOTATION) then the default value will be used. | |
| certificate_name | string | The X.509 certificate name attached to the APIC AAA user used for signature-based authentication. If a C(private_key) filename was provided, this defaults to the C(private_key) basename, without extension. If PEM-formatted content was provided for C(private_key), this defaults to the C(username) value. If the value is not specified in the task, the value of environment variable C(ACI_CERTIFICATE_NAME) will be used instead. | ||
| description | string | Description for the maintenance policy. | ||
| download_state | string | The download state of the executable policies. The APIC defaults to C(untriggered) when unset during creation. | ||
| graceful | bool | Whether the system will bring down the nodes gracefully during an upgrade, which reduces traffic lost. The APIC defaults to C(false) when unset during creation. | ||
| host | string | IP Address or hostname of APIC resolvable by Ansible control host. If the value is not specified in the task, the value of environment variable C(ACI_HOST) will be used instead. | ||
| ignore_compat | bool | To check whether compatibility checks should be ignored The APIC defaults to C(false) when unset during creation. | ||
| name | string | The name for the maintenance policy. | ||
| name_alias | string | The alias for the current object. This relates to the nameAlias field in ACI. | ||
| notify_condition | string | Specifies under what pause condition will admin be notified via email/text as configured. This notification mechanism is independent of events/faults. The APIC defaults to C(notifyOnlyOnFailures) when unset during creation. | ||
| output_level | string | normal | Influence the output of this ACI module. C(normal) means the standard output, incl. C(current) dict C(info) adds informational output, incl. C(previous), C(proposed) and C(sent) dicts C(debug) adds debugging output, incl. C(filter_string), C(method), C(response), C(status) and C(url) information If the value is not specified in the task, the value of environment variable C(ACI_OUTPUT_LEVEL) will be used instead. | |
| output_path | string | Path to a file that will be used to dump the ACI JSON configuration objects generated by the module. If the value is not specified in the task, the value of environment variable C(ACI_OUTPUT_PATH) will be used instead. | ||
| password | string | The password to use for authentication. This option is mutual exclusive with C(private_key). If C(private_key) is provided too, it will be used instead. If the value is not specified in the task, the value of environment variables C(ACI_PASSWORD) or C(ANSIBLE_NET_PASSWORD) will be used instead. | ||
| port | int | Port number to be used for REST connection. The default value depends on parameter C(use_ssl). If the value is not specified in the task, the value of environment variable C(ACI_PORT) will be used instead. | ||
| private_key | string | Either a PEM-formatted private key file or the private key content used for signature-based authentication. This value also influences the default C(certificate_name) that is used. This option is mutual exclusive with C(password). If C(password) is provided too, it will be ignored. If the value is not specified in the task, the value of environment variable C(ACI_PRIVATE_KEY) or C(ANSIBLE_NET_SSH_KEYFILE) will be used instead. | ||
| run_mode | string | Whether the system pauses on error or just continues through it. The APIC defaults to C(pauseOnlyOnFailures) when unset during creation. | ||
| scheduler | string | The name of scheduler that is applied to the policy. | ||
| smu_operation | string | Specifies that the upgrade is a Software Maintenance Upgrade (SMU) patch operation. | ||
| smu_operation_flags | string | Specifies the Software Maintenance Upgrade (SMU) patch operation flags Indicates if node should be reloaded immediately or skip auto reload on SMU Install/Uninstall. | ||
| sr_upgrade | bool | Specifies that the upgrade is a Silent Roll (SR) package upgrade. | ||
| sr_version | string | The target firmware version of the Silent Roll (SR) package upgrade to install. | ||
| state | string | present | Use C(present) or C(absent) for adding or removing. Use C(query) for listing an object or multiple objects. | |
| suppress_previous | bool | If C(true), a GET to check previous will not be sent before a POST update to APIC. If the value is not specified in the task, the value of environment variable C(ACI_SUPPRESS_PREVIOUS) will be used instead. The default value is C(false). WARNING - This causes the previous return value to be empty. The previous state of the object will not be checked and the POST update will contain all properties. | ||
| suppress_verification | bool | If C(true), a verifying GET will not be sent after a POST update to APIC. If the value is not specified in the task, the value of environment variable C(ACI_SUPPRESS_VERIFICATION) will be used instead. The default value is C(false). WARNING - This causes the current return value to be set to the proposed value. The current object including default values will be unverifiable in a single task. | ||
| timeout | int | The socket level timeout in seconds. If the value is not specified in the task, the value of environment variable C(ACI_TIMEOUT) will be used instead. The default value is 30. | ||
| use_proxy | bool | If C(false), it will not use a proxy, even if one is defined in an environment variable on the target hosts. If the value is not specified in the task, the value of environment variable C(ACI_USE_PROXY) will be used instead. The default value is true. | ||
| use_ssl | bool | If C(false), an HTTP connection will be used instead of the default HTTPS connection. If the value is not specified in the task, the value of environment variable C(ACI_USE_SSL) will be used instead. The default value is true when the connection is local. | ||
| username | string | The username to use for authentication. If the value is not specified in the task, the value of environment variables C(ACI_USERNAME) or C(ANSIBLE_NET_USERNAME) will be used instead. The default value is admin. | ||
| validate_certs | bool | If C(false), SSL certificates will not be validated. This should only set to C(false) when used on personally controlled sites using self-signed certificates. If the value is not specified in the task, the value of environment variable C(ACI_VALIDATE_CERTS) will be used instead. The default value is true. | ||
| version | string | The target firmware version to install. | ||
| version_check_override | string | The version check override. This is a directive to ignore the version check for the next install. The version check, which occurs during a maintenance window, checks to see if the desired version matches the running version. If the versions do not match, the install is performed. If the versions do match, the install is not performed. The version check override is a one-time override that performs the install whether or not the versions match. The APIC defaults to C(untriggered) when unset during creation. |
Example
yaml
- {"cisco.aci.aci_maintenance_policy": {"host": "apic", "name": "my_maintenance_policy", "password": "SomeSecretPassword", "scheduler": "simpleScheduler", "state": "present", "username": "admin"}, "delegate_to": "localhost", "name": "Create a maintenance policy"}
- {"cisco.aci.aci_maintenance_policy": {"host": "apic", "name": "my_maintenance_policy", "password": "SomeSecretPassword", "state": "absent", "username": "admin"}, "delegate_to": "localhost", "name": "Delete a maintenance policy"}
- {"cisco.aci.aci_maintenance_policy": {"host": "apic", "password": "SomeSecretPassword", "state": "query", "username": "admin"}, "delegate_to": "localhost", "name": "Query all maintenance policies", "register": "query_result"}
- {"cisco.aci.aci_maintenance_policy": {"host": "apic", "name": "my_maintenance_policy", "password": "SomeSecretPassword", "state": "query", "username": "admin"}, "delegate_to": "localhost", "name": "Query a specific maintenance policy", "register": "query_result"}