aci_epg_useg_attribute_simple_statement

Manage EPG useg Attributes Simple Statements (fv:DnsAttr, fv:IdGroupAttr, fv:IpAttr, fv:MacAttr, and fv:VmAttr)

Collection: cisco.aci

Full Name: cisco.aci.aci_epg_useg_attribute_simple_statement

Synopsis

Manage EPG useg Attributes Simple Statements (fv:DnsAttr, fv:IdGroupAttr, fv:IpAttr, fv:MacAttr, and fv:VmAttr)

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 an existing application network profile.
category	string			The name of the vmware tag category or vmware custom attribute.
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.
epg	string			The name of an existing 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.
name	string			The name of the EPG useg attribute.
operator	string			The operator of the EPG useg attribute.
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.
parent_block_statements	list			The list of parent block statements. The order of the provided list matters, assuming the list [“A”, “B”, “C”]. The block statement “A” will be the parent of “B” The block statement “A” will be a child of the default block statement. The maximum amount of parent block statements is 3.
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.
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.
tenant	string			The name of an existing 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.
type	string	yes		The type of the EPG useg attribute
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.
use_subnet	bool			Whether to use the EPG subnet definition for ip.
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.
value	string			The value of the EPG useg attribute.

Example

yaml

- {"cisco.aci.aci_epg_useg_attribute_simple_statement": {"ap": "anstest", "category": "Environment", "epg": "anstest", "host": "apic", "name": "vmtagprod", "operator": "equals", "password": "SomeSecretPassword", "state": "present", "tenant": "anstest", "type": "vm_tag", "username": "admin", "value": "Production"}, "delegate_to": "localhost", "name": "Add a new vmtag useg attribute in default block statement"}

- {"cisco.aci.aci_epg_useg_attribute_simple_statement": {"ap": "anstest", "category": "Environment", "epg": "anstest", "host": "apic", "name": "vmtagprod", "operator": "equals", "parent_block_statements": ["block_a", "block_b"], "password": "SomeSecretPassword", "state": "present", "tenant": "anstest", "type": "vm_tag", "username": "admin", "value": "Production"}, "delegate_to": "localhost", "name": "Add a new vmtag useg attribute in nested block statement"}

- {"cisco.aci.aci_epg_useg_attribute_simple_statement": {"ap": "anstest", "epg": "anstest", "host": "apic", "name": "vmtagprod", "password": "SomeSecretPassword", "state": "query", "tenant": "anstest", "type": "vm_tag", "username": "admin"}, "delegate_to": "localhost", "name": "Query a specific vmtag useg attribute in default block statement", "register": "query_result"}

- {"cisco.aci.aci_epg_useg_attribute_simple_statement": {"host": "apic", "password": "SomeSecretPassword", "state": "query", "type": "vm_tag", "username": "admin"}, "delegate_to": "localhost", "name": "Query all vmtag useg attributes", "register": "query_result"}

- {"cisco.aci.aci_epg_useg_attribute_simple_statement": {"ap": "anstest", "epg": "anstest", "host": "apic", "name": "vmtagprod", "password": "SomeSecretPassword", "state": "absent", "tenant": "anstest", "type": "vm_tag", "username": "admin"}, "delegate_to": "localhost", "name": "Remove an existing vmtag useg attribute from default block statement"}