aci_syslog_group
Manage syslog destination groups on Cisco ACI
Collection: cisco.aci
Full Name: cisco.aci.aci_syslog_group
Synopsis
Manage syslog destination groups on Cisco ACI
Parameters
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| admin_state | string | Administrative state of the syslog group. | ||
| 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. | |
| 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. | ||
| console_log_format | string | Format of the console log messages. If unset during creation and O(format) is provided then it is set to the same value as format. If O(format) is not provided it is set to C(aci). The option C(rfc5424_ts) is only available in ACI version 5.2(8) or later. The option C(enhanced_log) is only available in ACI version 6.0(9d) or later and is an alias to C(rfc5424_ts). | ||
| console_log_severity | string | Severity of events to log to console. If unset during creation, value defaults to C(alerts). | ||
| console_logging | string | Log events to console. | ||
| description | string | Description for the syslog group. | ||
| format | string | Format of the syslog messages. If unset during creation the value defaults to C(aci). C(rfc5424_ts) is only available starting from ACI version 5.2(8). C(enhanced_log) is only available starting from ACI version 6.0(9d) and is an alias to C(rfc5424_ts). | ||
| 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. | ||
| include_ms | bool | Include milliseconds in log timestamps. | ||
| include_time_zone | bool | Include timezone in log timestamps. | ||
| local_file_log_format | string | The format of the local file log messages. If unset during creation and O(format) is provided then it is set to the same value as format. If O(format) is not provided it is set to C(aci). C(rfc5424_ts) is only available starting from ACI version 5.2(8). C(enhanced_log) is only available starting from ACI version 6.0(9d) and is an alias to C(rfc5424_ts). | ||
| local_file_log_severity | string | Severity of events to log to local file. If unset during creation, value defaults to C(alerts). | ||
| local_file_logging | string | Log to local file. | ||
| name | string | Name of the syslog group. | ||
| 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. | ||
| 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. | ||
| 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_syslog_group": {"console_log_severity": "critical", "console_logging": "enabled", "description": "syslog group", "host": "apic", "local_file_log_severity": "warnings", "local_file_logging": "enabled", "name": "my_syslog_group", "password": "SomeSecretPassword", "state": "present", "username": "admin"}, "delegate_to": "localhost", "name": "Create a syslog group"}
- {"cisco.aci.aci_syslog_group": {"console_log_format": "rfc5424_ts", "console_log_severity": "critical", "console_logging": "enabled", "description": "syslog group", "format": "aci", "host": "apic", "local_file_log_format": "rfc5424_ts", "local_file_log_severity": "warnings", "local_file_logging": "enabled", "name": "my_syslog_group", "password": "SomeSecretPassword", "state": "present", "username": "admin"}, "name": "Create a syslog group with local_file_log_format and console_log_format"}
- {"cisco.aci.aci_syslog_group": {"host": "apic", "local_file_logging": "disabled", "name": "my_syslog_group", "password": "SomeSecretPassword", "state": "present", "username": "admin"}, "delegate_to": "localhost", "name": "Disable logging to local file"}
- {"cisco.aci.aci_syslog_group": {"host": "apic", "name": "my_syslog_group", "password": "SomeSecretPassword", "state": "absent", "username": "admin"}, "delegate_to": "localhost", "name": "Remove a syslog group"}
- {"cisco.aci.aci_syslog_group": {"host": "apic", "name": "my_syslog_group", "password": "SomeSecretPassword", "state": "query", "username": "admin"}, "delegate_to": "localhost", "name": "Query a syslog group", "register": "query_result"}
- {"cisco.aci.aci_syslog_group": {"host": "apic", "password": "SomeSecretPassword", "state": "query", "username": "admin"}, "delegate_to": "localhost", "name": "Query all syslog groups", "register": "query_result"}