aci_subject_label
Manage Subject Labels (vz:ConsSubjLbl and vz:ProvSubjLbl)
Collection: cisco.aci
Full Name: cisco.aci.aci_subject_label
Synopsis
Manage Subject Labels (vz:ConsSubjLbl and vz:ProvSubjLbl)
Parameters
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| 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. | |
| ap | string | The name of the Application Profile. | ||
| 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. | ||
| complement | bool | Whether complement is enabled on the Subject Label. The APIC defaults to C(false) when unset during creation. | ||
| contract | string | The name of the Contract. | ||
| description | string | The description for the Subject Label. | ||
| epg | string | The name of the End Point Group. | ||
| esg | string | The name of the Endpoint Security Group. | ||
| external_epg | string | The name of the External End Point Group. | ||
| 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. | ||
| l2out | string | The name of the L2Out. | ||
| l3out | string | The name of the L3Out. | ||
| name_alias | string | The alias for the current object. This relates to the nameAlias field in ACI. | ||
| 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. | ||
| owner_key | string | User-defined string for the ownerKey attribute of an ACI object. This attribute represents a key for enabling clients to own their data for entity correlation. If the value is not specified in the task, the value of environment variable C(ACI_OWNER_KEY) will be used instead. | ||
| owner_tag | string | User-defined string for the ownerTag attribute of an ACI object. This attribute represents a tag for enabling clients to add their own data. For example, to indicate who created this object. If the value is not specified in the task, the value of environment variable C(ACI_OWNER_TAG) 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. | ||
| state | string | present | Use C(present) or C(absent) for adding or removing. Use C(query) for listing an object or multiple objects. | |
| subject | string | The name of the Subject. | ||
| subject_label | string | The name of the Subject Label. | ||
| subject_label_type | string | yes | Determines the type of the Subject Label. | |
| 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. | ||
| tag | string | The color of a policy label of the Subject Label. The APIC defaults to C(yellow-green) when unset during creation. | ||
| tenant | string | The name of the Tenant. | ||
| 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. |
Example
yaml
- {"cisco.aci.aci_subject_label": {"contract": "web", "host": "apic", "password": "SomeSecretPassword", "state": "present", "subject": "web_subject", "subject_label": "web_subject_label", "subject_label_type": "consumer", "tenant": "production", "username": "admin"}, "delegate_to": "localhost", "name": "Add a Subject Label on a Contract Subject"}
- {"cisco.aci.aci_subject_label": {"external_epg": "external_epg_name", "host": "apic", "l2out": "l2out_name", "password": "SomeSecretPassword", "state": "present", "subject_label": "l2out_subject_label", "subject_label_type": "consumer", "tenant": "production", "username": "admin"}, "delegate_to": "localhost", "name": "Add a Subject Label on a L2Out External EPG"}
- {"cisco.aci.aci_subject_label": {"external_epg": "external_epg_name", "host": "apic", "l3out": "l3out_name", "password": "SomeSecretPassword", "state": "present", "subject_label": "l3out_subject_label", "subject_label_type": "consumer", "tenant": "production", "username": "admin"}, "delegate_to": "localhost", "name": "Add a Subject Label on a L3Out External EPG"}
- {"cisco.aci.aci_subject_label": {"contract": "web", "external_epg": "external_epg_name", "host": "apic", "l3out": "l3out_name", "password": "SomeSecretPassword", "state": "present", "subject_label": "l3out_subject_label", "subject_label_type": "consumer", "tenant": "production", "username": "admin"}, "delegate_to": "localhost", "name": "Add a Subject Label on a L3Out External EPG Contract"}
- {"cisco.aci.aci_subject_label": {"ap": "app_profile_name", "esg": "esg_name", "host": "apic", "password": "SomeSecretPassword", "state": "present", "subject_label": "esg_subject_label", "subject_label_type": "consumer", "tenant": "production", "username": "admin"}, "delegate_to": "localhost", "name": "Add a Subject Label on a ESG"}
- {"cisco.aci.aci_subject_label": {"ap": "app_profile_name", "epg": "epg_name", "host": "apic", "password": "SomeSecretPassword", "state": "present", "subject_label": "epg_subject_label", "subject_label_type": "consumer", "tenant": "production", "username": "admin"}, "delegate_to": "localhost", "name": "Add a Subject Label on a EPG"}
- {"cisco.aci.aci_subject_label": {"ap": "app_profile_name", "contract": "web", "epg": "epg_name", "host": "apic", "password": "SomeSecretPassword", "state": "present", "subject_label": "epg_subject_label", "subject_label_type": "consumer", "tenant": "production", "username": "admin"}, "delegate_to": "localhost", "name": "Add a Subject Label on a EPG Contract"}
- {"cisco.aci.aci_subject_label": {"contract": "web", "host": "apic", "password": "SomeSecretPassword", "state": "query", "subject": "web_subject", "subject_label": "web_subject_label", "subject_label_type": "consumer", "tenant": "production", "username": "admin"}, "delegate_to": "localhost", "name": "Query a Subject Label on a Contract Subject", "register": "query_result"}
- {"cisco.aci.aci_subject_label": {"host": "apic", "password": "SomeSecretPassword", "state": "query", "username": "admin", subject_label_type: consumer}, "delegate_to": "localhost", "name": "Query all Subject Labels", "register": "query_result"}
- {"cisco.aci.aci_subject_label": {"contract": "web", "host": "apic", "password": "SomeSecretPassword", "state": "absent", "subject": "web_subject", "subject_label": "web_subject_label", "subject_label_type": "consumer", "tenant": "production", "username": "admin"}, "delegate_to": "localhost", "name": "Remove a Subject Label on a Contract Subject"}