cisco.intersight.intersight_virtual_media_policy_info module – Gather information about Virtual Media Policies

Note

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

Synopsis

  • Gathers information about Virtual Media Policies on Cisco Intersight.

  • For more information see Cisco Intersight.

Parameters

Parameter

Comments

api_bearer_token

string

Bearer token for OAuth2 authentication with the Intersight API.

When provided, api_key_id and api_private_key are not required and the cryptography Python library is not needed.

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

api_key_id

string

Public API Key ID associated with the private key.

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

Required if api_bearer_token is not provided.

api_private_key

path

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.

Required if api_bearer_token is not provided.

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 assigned to the Virtual Media Policy.

organization

string

The name of the Organization this resource is assigned to.

Default: "default"

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: Get Virtual Media Policy Info
  cisco.intersight.intersight_virtual_media_policy_info:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    name: "virtual-media-policy"

Return Values

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

Key

Description

api_response

list / elements=string

The API response output returned by the specified resource.

Returned: always

Sample: [{"Mappings": [], "Name": "virtual-media-policy", "ObjectType": "vmedia.Policy"}]

Authors

  • Steve Fulmer (@sfulmer)