Documentation

aci_contract - Manage contract resources on Cisco ACI fabrics (vz:BrCP)

New in version 2.4.

Synopsis

Options

parameter required default choices comments
contract
 yes
The name of the contract.

aliases: contract_name, name
description
 no
Description for the contract.

aliases: descr
dscp
 no unspecified
  • AF11
  • AF12
  • AF13
  • AF21
  • AF22
  • AF23
  • AF31
  • AF32
  • AF33
  • AF41
  • AF42
  • AF43
  • CS0
  • CS1
  • CS2
  • CS3
  • CS4
  • CS5
  • CS6
  • CS7
  • EF
  • VA
  • unspecified
The target Differentiated Service (DSCP) value.

aliases: target
hostname
 yes
IP Address or hostname of APIC resolvable by Ansible control host.

aliases: host
password
 yes
The password to use for authentication.
priority
 no unspecified
  • level1
  • level2
  • level3
  • unspecified
The desired QoS class to be used.
scope
 no context
  • application-profile
  • context
  • global
  • tenant
The scope of a service contract.
state
 no present
  • absent
  • present
  • query
Use present or absent for adding or removing.
Use query for listing an object or multiple objects.
tenant
 yes
The name of the tenant.

aliases: tenant_name
timeout
 no 30
The socket level timeout in seconds.
use_proxy
 no yes
  • yes
  • no
If no, it will not use a proxy, even if one is defined in an environment variable on the target hosts.
use_ssl
 no yes
  • yes
  • no
If no, an HTTP connection will be used instead of the default HTTPS connection.
username
 yes admin
The username to use for authentication.

aliases: user
validate_certs
 no yes
  • yes
  • no
If no, SSL certificates will not be validated.
This should only set to no used on personally controlled sites using self-signed certificates.

Examples

- aci_contract:
    hostname: '{{ inventory_hostname }}'
    username: '{{ username }}'
    password: '{{ password }}'
    contract: '{{ contract }}'
    description: '{{ descr }}'
    tenant: '{{ tenant }}'
    scope: '{{ scope }}'
    priority: '{{ priority }}'
    target: '{{ target }}'

Notes

Note

  • This module does not manage Contract Subjects, see aci_contract_subject to do this. Contract Subjects can still be removed using this module.
  • The tenant used must exist before using this module in your playbook. The aci_tenant module can be used for this.
  • By default, if an environment variable <protocol>_proxy is set on the target host, requests will be sent through that proxy. This behaviour can be overridden by setting a variable for this task (see setting the environment), or by using the use_proxy option.
  • HTTP redirects can redirect from HTTP to HTTPS so you should be sure that your proxy environment for both protocols is correct.

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.