aci_fabric_scheduler – This modules creates ACI schedulers

From Get docs
Ansible/docs/2.8/modules/aci fabric scheduler module


aci_fabric_scheduler – This modules creates ACI schedulers

New in version 2.8.


Synopsis

  • With the module you can create schedule policies that can be a shell, onetime execution or recurring

Parameters

Parameter Choices/Defaults Comments

certificate_name

string

The X.509 certificate name attached to the APIC AAA user used for signature-based authentication.

If a private_key filename was provided, this defaults to the private_key basename, without extension.

If PEM-formatted content was provided for private_key, this defaults to the username value.


aliases: cert_name

concurCap

integer

This is the amount of devices that can be executed on at a time

date

-

This is the date and time that the scheduler will execute

day

-

  • Monday
  • Tuesday
  • Wednesday
  • Thursday
  • Friday
  • Saturday
  • Sunday
  • even-day
  • odd-day
  • every-day

This sets the day when execution will take place

description

-

Description for the Scheduler.


aliases: descr

host

string / required

IP Address or hostname of APIC resolvable by Ansible control host.


aliases: hostname

hour

-

This set the hour of execution

maxTime

-

This is the amount MAX amount of time a process can be executed

minute

-

This sets the minute of execution, used in conjunction with hour

name

- / required

The name of the Scheduler.


aliases: name, scheduler_name

output_level

string

  • debug
  • info
  • normal

Influence the output of this ACI module.

normal means the standard output, incl. current dict

info adds informational output, incl. previous, proposed and sent dicts

debug adds debugging output, incl. filter_string, method, response, status and url information

password

string / required

The password to use for authentication.

This option is mutual exclusive with private_key. If private_key is provided too, it will be used instead.

port

integer

Port number to be used for REST connection.

The default value depends on parameter use_ssl.

private_key

string / required

Either a PEM-formatted private key file or the private key content used for signature-based authentication.

This value also influences the default certificate_name that is used.

This option is mutual exclusive with password. If password is provided too, it will be ignored.


aliases: cert_key

recurring

boolean

  • no

  • yes

If you want to make the Scheduler a recurring it would be a "True" and for a oneTime execution it would be "False". For a shell just exclude this option from the task

state

-

  • absent
  • present

  • query

Use present or absent for adding or removing.

Use query for listing an object or multiple objects.

timeout

integer

Default:

30

The socket level timeout in seconds.

use_proxy

boolean

  • no
  • yes

If no, it will not use a proxy, even if one is defined in an environment variable on the target hosts.

use_ssl

boolean

  • no
  • yes

If no, an HTTP connection will be used instead of the default HTTPS connection.

username

string

Default:

"admin"

The username to use for authentication.


aliases: user

validate_certs

boolean

  • no
  • yes

If no, SSL certificates will not be validated.

This should only set to no when used on personally controlled sites using self-signed certificates.

windowname

-

This is the name for your what recurring or oneTime execution



See Also

See also

Cisco ACI Guide
Detailed information on how to manage your ACI infrastructure using Ansible.
Developing Cisco ACI modules
Detailed guide on how to write your own Cisco ACI modules to contribute.


Examples

- name: Simple Scheduler (Empty)
  aci_fabric_scheduler:
     host: "{{ inventory_hostname }}"
     username: "{{ user }}"
     password: "{{ pass }}"
     validate_certs: no
     name: simpleScheduler
     state: present
- name: Remove Simple Scheduler
  aci_fabric_scheduler:
     host: "{{ inventory_hostname }}"
     username: "{{ user }}"
     password: "{{ pass }}"
     validate_certs: no
     name: simpleScheduler
     state: absent
- name: One Time Scheduler
  aci_fabric_scheduler:
     host: "{{ inventory_hostname }}"
     username: "{{ user }}"
     password: "{{ pass }}"
     validate_certs: no
     name: OneTime
     windowname: OneTime
     recurring: False
     concurCap: 20
     date: "2018-11-20T24:00:00"
     state: present
- name: Recurring Scheduler
  aci_fabric_scheduler:
     host: "{{ inventory_hostname }}"
     username: "{{ user }}"
     password: "{{ pass }}"
     validate_certs: no
     name: Recurring
     windowname: Recurring
     recurring: True
     concurCap: 20
     hour: 13
     minute: 30
     day: Tuesday
     state: present

Return Values

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

Key Returned Description

current

list

success

The existing configuration from the APIC after the module has finished


Sample:

[{'fvTenant': {'attributes': {'descr': 'Production environment', 'dn': 'uni/tn-production', 'name': 'production', 'nameAlias': , 'ownerKey': , 'ownerTag': }}}]

error

dictionary

failure

The error information as returned from the APIC


Sample:

{'code': '122', 'text': 'unknown managed object class foo'}

filter_string

string

failure or debug

The filter string used for the request


Sample:

?rsp-prop-include=config-only

method

string

failure or debug

The HTTP method used for the request to the APIC


Sample:

POST

previous

list

info

The original configuration from the APIC before the module has started


Sample:

[{'fvTenant': {'attributes': {'descr': 'Production', 'dn': 'uni/tn-production', 'name': 'production', 'nameAlias': , 'ownerKey': , 'ownerTag': }}}]

proposed

dictionary

info

The assembled configuration from the user-provided parameters


Sample:

{'fvTenant': {'attributes': {'descr': 'Production environment', 'name': 'production'}}}

raw

string

parse error

The raw output returned by the APIC REST API (xml or json)


Sample:


response

string

failure or debug

The HTTP response from the APIC


Sample:

OK (30 bytes)

sent

list

info

The actual/minimal configuration pushed to the APIC


Sample:

{'fvTenant': {'attributes': {'descr': 'Production environment'}}}

status

integer

failure or debug

The HTTP status from the APIC


Sample:

200

url

string

failure or debug

The HTTP url used for the request to the APIC


Sample:




Status

Authors

  • Steven Gerhart (@sgerhart)

Hint

If you notice any issues in this documentation you can edit this document to improve it.


© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/aci_fabric_scheduler_module.html