cisco.intersight.intersight_syslog_policy_info module – Gather information about Syslog Policies in Cisco Intersight

Note

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

To use it in a playbook, specify: cisco.intersight.intersight_syslog_policy_info.

Synopsis

  • Gathers information about existing Syslog Policies in Cisco Intersight.

  • You can filter policies by organization and name.

  • If no filters are provided, the module returns all available Syslog Policies.

Parameters

Parameter

Comments

api_key_id

string / required

Public API Key ID associated with the private key.

If not set, the value of the INTERSIGHT_API_KEY_ID environment variable is used.

api_private_key

path / required

Filename (absolute path) or string of PEM formatted private key data to be used for Intersight API authentication.

If a string is used, Ansible vault should be used to encrypt string data.

Ex. ansible-vault encrypt_string –vault-id tme@/Users/dsoper/Documents/vault_password_file ‘—–BEGIN EC PRIVATE KEY—–

<your private key data>

—–END EC PRIVATE KEY—–’

If not set, the value of the INTERSIGHT_API_PRIVATE_KEY environment variable is used.

api_uri

string

URI used to access the Intersight API.

If not set, the value of the INTERSIGHT_API_URI environment variable is used.

Default: "https://intersight.com/api/v1"

name

string

The name of the specific Syslog Policy to retrieve.

organization

string

The name of the organization to which the Syslog Policy belongs.

use_proxy

boolean

If no, it will not use a proxy, even if one is defined in an environment variable on the target hosts.

Choices:

  • false

  • true ← (default)

validate_certs

boolean

Boolean control for verifying the api_uri TLS certificate

Choices:

  • false

  • true ← (default)

Examples

- name: Fetch a specific Syslog Policy by name
  cisco.intersight.intersight_syslog_policy_info:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    name: "Syslog-Policy-PROD"

- name: Fetch all Syslog Policies
  cisco.intersight.intersight_syslog_policy_info:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"

Return Values

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

Key

Description

api_repsonse

dictionary

The API response output returned by the specified resource.

Returned: always

Sample: {"api_response": [{"Name": "mac_pool_1", "ObjectType": "macpool.Pool", "Tags": [{"Key": "Site", "Value": "tag1"}, {"Key": "Site2", "Value": "tag2"}]}, {"Name": "mac_pool_2", "ObjectType": "macpool.Pool", "Tags": [{"Key": "Site1", "Value": "tag1"}, {"Key": "Site2", "Value": "tag2"}]}]}

Authors

  • Ron Gershburg (@rgershbu)