ansible.builtin.aci_contract_subject (v2.9.0) — module

Install Ansible via pip

Install with pip install ansible==2.9.0

Description

Manage initial Contract Subjects on Cisco ACI fabrics.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Add a new contract subject
  aci_contract_subject:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    contract: web_to_db
    subject: default
    description: test
    reverse_filter: yes
    priority: level1
    dscp: unspecified
    state: present
  register: query_result

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Query a contract subject
  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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

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

Inputs

    
dscp:
    aliases:
    - target
    choices:
    - AF11
    - AF12
    - AF13
    - AF21
    - AF22
    - AF23
    - AF31
    - AF32
    - AF33
    - AF41
    - AF42
    - AF43
    - CS0
    - CS1
    - CS2
    - CS3
    - CS4
    - CS5
    - CS6
    - CS7
    - EF
    - VA
    - unspecified
    description:
    - The target DSCP.
    - The APIC defaults to C(unspecified) when unset during creation.
    type: str

host:
    aliases:
    - hostname
    description:
    - IP Address or hostname of APIC resolvable by Ansible control host.
    required: true
    type: str

port:
    description:
    - Port number to be used for REST connection.
    - The default value depends on parameter C(use_ssl).
    type: int

state:
    choices:
    - absent
    - present
    - query
    default: present
    description:
    - Use C(present) or C(absent) for adding or removing.
    - Use C(query) for listing an object or multiple objects.
    type: str

tenant:
    aliases:
    - tenant_name
    description:
    - The name of the tenant.
    type: str

subject:
    aliases:
    - contract_subject
    - name
    - subject_name
    description:
    - The contract subject name.
    type: str

timeout:
    default: 30
    description:
    - The socket level timeout in seconds.
    type: int

use_ssl:
    default: true
    description:
    - If C(no), an HTTP connection will be used instead of the default HTTPS connection.
    type: bool

contract:
    aliases:
    - contract_name
    description:
    - The name of the Contract.
    type: str

password:
    description:
    - 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.
    required: true
    type: str

priority:
    choices:
    - level1
    - level2
    - level3
    - unspecified
    description:
    - The QoS class.
    - The APIC defaults to C(unspecified) when unset during creation.
    type: str

username:
    aliases:
    - user
    default: admin
    description:
    - The username to use for authentication.
    type: str

use_proxy:
    default: true
    description:
    - If C(no), it will not use a proxy, even if one is defined in an environment variable
      on the target hosts.
    type: bool

description:
    aliases:
    - descr
    description:
    - Description for the contract subject.
    type: str

private_key:
    aliases:
    - cert_key
    description:
    - 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.
    required: true
    type: str

output_level:
    choices:
    - debug
    - info
    - normal
    default: normal
    description:
    - 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
    type: str

consumer_match:
    choices:
    - all
    - at_least_one
    - at_most_one
    - none
    description:
    - The match criteria across consumers.
    - The APIC defaults to C(at_least_one) when unset during creation.
    type: str

provider_match:
    choices:
    - all
    - at_least_one
    - at_most_one
    - none
    description:
    - The match criteria across providers.
    - The APIC defaults to C(at_least_one) when unset during creation.
    type: str

reverse_filter:
    description:
    - 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 C(yes) when unset during creation.
    type: bool

validate_certs:
    default: true
    description:
    - If C(no), SSL certificates will not be validated.
    - This should only set to C(no) when used on personally controlled sites using self-signed
      certificates.
    type: bool

certificate_name:
    aliases:
    - cert_name
    description:
    - 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.
    type: str

Outputs

current:
  description: 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: ''
  type: list
error:
  description: The error information as returned from the APIC
  returned: failure
  sample:
    code: '122'
    text: unknown managed object class foo
  type: dict
filter_string:
  description: The filter string used for the request
  returned: failure or debug
  sample: ?rsp-prop-include=config-only
  type: str
method:
  description: The HTTP method used for the request to the APIC
  returned: failure or debug
  sample: POST
  type: str
previous:
  description: 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: ''
  type: list
proposed:
  description: The assembled configuration from the user-provided parameters
  returned: info
  sample:
    fvTenant:
      attributes:
        descr: Production environment
        name: production
  type: dict
raw:
  description: 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>
  type: str
response:
  description: The HTTP response from the APIC
  returned: failure or debug
  sample: OK (30 bytes)
  type: str
sent:
  description: The actual/minimal configuration pushed to the APIC
  returned: info
  sample:
    fvTenant:
      attributes:
        descr: Production environment
  type: list
status:
  description: The HTTP status from the APIC
  returned: failure or debug
  sample: 200
  type: int
url:
  description: 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
  type: str

See also

• aci_contract
• aci_tenant
• APIC Management Information Model reference: More information about the internal APIC class B(vz:Subj). link
• Ansible docs: Detailed information on how to manage your ACI infrastructure using Ansible. link
• Ansible docs: Detailed guide on how to write your own Cisco ACI modules to contribute. link