cisco.aci.aci_contract_subject module – Manage initial Contract Subjects (vz:Subj)

Note

This module is part of the cisco.aci collection (version 2.12.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.aci.

To use it in a playbook, specify: cisco.aci.aci_contract_subject.

Synopsis

  • Manage initial Contract Subjects on Cisco ACI fabrics.

Parameters

Parameter

Comments

annotation

string

User-defined string for annotating an object.

If the value is not specified in the task, the value of environment variable ACI_ANNOTATION will be used instead.

If the value is not specified in the task and environment variable ACI_ANNOTATION then the default value will be used.

Default: "orchestrator:ansible"

apply_both_direction

string

The direction of traffic matching for the filter.

Choices:

  • "both" ← (default)

  • "one-way"

certificate_name

aliases: cert_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.

If the value is not specified in the task, the value of environment variable ACI_CERTIFICATE_NAME will be used instead.

consumer_match

string

The match criteria across consumers.

The APIC defaults to at_least_one when unset during creation.

Choices:

  • "all"

  • "at_least_one"

  • "at_most_one"

  • "none"

contract

aliases: contract_name

string

The name of the Contract.

description

aliases: descr

string

Description for the contract subject.

dscp

aliases: target

string

The target DSCP.

The APIC defaults to unspecified when unset during creation.

Choices:

  • "AF11"

  • "AF12"

  • "AF13"

  • "AF21"

  • "AF22"

  • "AF23"

  • "AF31"

  • "AF32"

  • "AF33"

  • "AF41"

  • "AF42"

  • "AF43"

  • "CS0"

  • "CS1"

  • "CS2"

  • "CS3"

  • "CS4"

  • "CS5"

  • "CS6"

  • "CS7"

  • "EF"

  • "VA"

  • "unspecified"

dscp_consumer_to_provider

aliases: target_consumer_to_provider

string

The target DSCP of Filter Chain For Consumer to Provider.

The APIC defaults to unspecified when unset during creation.

Choices:

  • "AF11"

  • "AF12"

  • "AF13"

  • "AF21"

  • "AF22"

  • "AF23"

  • "AF31"

  • "AF32"

  • "AF33"

  • "AF41"

  • "AF42"

  • "AF43"

  • "CS0"

  • "CS1"

  • "CS2"

  • "CS3"

  • "CS4"

  • "CS5"

  • "CS6"

  • "CS7"

  • "EF"

  • "VA"

  • "unspecified"

dscp_provider_to_consumer

aliases: target_provider_to_consumer

string

The target DSCP of Filter Chain For Provider to Consumer.

The APIC defaults to unspecified when unset during creation.

Choices:

  • "AF11"

  • "AF12"

  • "AF13"

  • "AF21"

  • "AF22"

  • "AF23"

  • "AF31"

  • "AF32"

  • "AF33"

  • "AF41"

  • "AF42"

  • "AF43"

  • "CS0"

  • "CS1"

  • "CS2"

  • "CS3"

  • "CS4"

  • "CS5"

  • "CS6"

  • "CS7"

  • "EF"

  • "VA"

  • "unspecified"

host

aliases: hostname

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 ACI_HOST will be used instead.

name_alias

string

The alias for the current object. This relates to the nameAlias field in ACI.

output_level

string

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

If the value is not specified in the task, the value of environment variable ACI_OUTPUT_LEVEL will be used instead.

Choices:

  • "debug"

  • "info"

  • "normal" ← (default)

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 ACI_OUTPUT_PATH will be used instead.

password

string

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.

If the value is not specified in the task, the value of environment variables ACI_PASSWORD or ANSIBLE_NET_PASSWORD will be used instead.

port

integer

Port number to be used for REST connection.

The default value depends on parameter use_ssl.

If the value is not specified in the task, the value of environment variable ACI_PORT will be used instead.

priority

string

The QoS class.

The APIC defaults to unspecified when unset during creation.

Choices:

  • "level1"

  • "level2"

  • "level3"

  • "unspecified"

priority_consumer_to_provider

string

The QoS class of Filter Chain For Consumer to Provider.

The APIC defaults to unspecified when unset during creation.

Choices:

  • "level1"

  • "level2"

  • "level3"

  • "unspecified"

priority_provider_to_consumer

string

The QoS class of Filter Chain For Provider to Consumer.

The APIC defaults to unspecified when unset during creation.

Choices:

  • "level1"

  • "level2"

  • "level3"

  • "unspecified"

private_key

aliases: cert_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 certificate_name that is used.

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

If the value is not specified in the task, the value of environment variable ACI_PRIVATE_KEY or ANSIBLE_NET_SSH_KEYFILE will be used instead.

provider_match

string

The match criteria across providers.

The APIC defaults to at_least_one when unset during creation.

Choices:

  • "all"

  • "at_least_one"

  • "at_most_one"

  • "none"

reverse_filter

boolean

Determines if the APIC should reverse the src and dst ports to allow the return traffic back, since ACI is stateless filter.

The APIC defaults to true when unset during creation.

Choices:

  • false

  • true

state

string

Use present or absent for adding or removing.

Use query for listing an object or multiple objects.

Choices:

  • "absent"

  • "present" ← (default)

  • "query"

subject

aliases: contract_subject, name, subject_name

string

The contract subject name.

suppress_previous

aliases: no_previous, ignore_previous

boolean

If 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 ACI_SUPPRESS_PREVIOUS will be used instead.

The default value is 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.

Choices:

  • false

  • true

suppress_verification

aliases: no_verification, no_verify, suppress_verify, ignore_verify, ignore_verification

boolean

If 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 ACI_SUPPRESS_VERIFICATION will be used instead.

The default value is 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.

Choices:

  • false

  • true

tenant

aliases: tenant_name

string

The name of the tenant.

timeout

integer

The socket level timeout in seconds.

If the value is not specified in the task, the value of environment variable ACI_TIMEOUT will be used instead.

The default value is 30.

use_proxy

boolean

If 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 ACI_USE_PROXY will be used instead.

The default value is true.

Choices:

  • false

  • true

use_ssl

boolean

If 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 ACI_USE_SSL will be used instead.

The default value is true when the connection is local.

Choices:

  • false

  • true

username

aliases: user

string

The username to use for authentication.

If the value is not specified in the task, the value of environment variables ACI_USERNAME or ANSIBLE_NET_USERNAME will be used instead.

The default value is admin.

validate_certs

boolean

If false, SSL certificates will not be validated.

This should only set to 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 ACI_VALIDATE_CERTS will be used instead.

The default value is true.

Choices:

  • false

  • true

Notes

Note

See Also

See also

cisco.aci.aci_contract

Manage contract resources (vz:BrCP).

cisco.aci.aci_tenant

Manage tenants (fv:Tenant).

APIC Management Information Model reference

More information about the internal APIC class vz:Subj.

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: Add a new contract subject
  cisco.aci.aci_contract_subject:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    contract: web_to_db
    subject: default
    description: test
    reverse_filter: true
    priority: level1
    dscp: unspecified
    state: present
  register: query_result

- name: Remove a contract subject
  cisco.aci.aci_contract_subject:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    contract: web_to_db
    subject: default
    state: absent
  delegate_to: localhost

- name: Query a contract subject
  cisco.aci.aci_contract_subject:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    contract: web_to_db
    subject: default
    state: query
  delegate_to: localhost
  register: query_result

- name: Query all contract subjects
  cisco.aci.aci_contract_subject:
    host: apic
    username: admin
    password: SomeSecretPassword
    state: query
  delegate_to: localhost
  register: query_result

Return Values

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

Key

Description

current

list / elements=string

The existing configuration from the APIC after the module has finished

Returned: success

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

error

dictionary

The error information as returned from the APIC

Returned: failure

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

filter_string

string

The filter string used for the request

Returned: failure or debug

Sample: "?rsp-prop-include=config-only"

method

string

The HTTP method used for the request to the APIC

Returned: failure or debug

Sample: "POST"

previous

list / elements=string

The original configuration from the APIC before the module has started

Returned: info

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

proposed

dictionary

The assembled configuration from the user-provided parameters

Returned: info

Sample: {"fvTenant": {"attributes": {"descr": "Production environment", "name": "production"}}}

raw

string

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

Returned: parse error

Sample: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><imdata totalCount=\"1\"><error code=\"122\" text=\"unknown managed object class foo\"/></imdata>"

response

string

The HTTP response from the APIC

Returned: failure or debug

Sample: "OK (30 bytes)"

sent

list / elements=string

The actual/minimal configuration pushed to the APIC

Returned: info

Sample: {"fvTenant": {"attributes": {"descr": "Production environment"}}}

status

integer

The HTTP status from the APIC

Returned: failure or debug

Sample: 200

url

string

The HTTP url used for the request to the APIC

Returned: failure or debug

Sample: "https://10.11.12.13/api/mo/uni/tn-production.json"

Authors

  • Swetha Chunduri (@schunduri)