cisco.intersight.intersight_imc_access_policy – IMC Access Policy configuration for Cisco Intersight

Note

This plugin is part of the cisco.intersight collection (version 1.0.17).

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_imc_access_policy.

New in version 2.10: of cisco.intersight

Synopsis
Parameters
Examples
Return Values

Synopsis

IMC Access Policy configuration for Cisco Intersight.
Used to configure IP addresses and VLAN used for external connectivity to Cisco IMC.
For more information see Cisco Intersight.

Parameters

Parameter	Choices/Defaults	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 string / 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	Default: "https://intersight.com/api/v1"	URI used to access the Intersight API. If not set, the value of the INTERSIGHT_API_URI environment variable is used.
descrption string		The user-defined description of the IMC access policy. Description can contain letters(a-z, A-Z), numbers(0-9), hyphen(-), period(.), colon(:), or an underscore(_). aliases: descr
ip_pool string / required		IP Pool used to assign IP address and other required network settings.
name string / required		The name assigned to the IMC Access Policy. The name must be between 1 and 62 alphanumeric characters, allowing special characters :-_.
organization string	Default: "default"	The name of the Organization this resource is assigned to. Profiles and Policies that are created within a Custom Organization are applicable only to devices in the same Organization.
state string	Choices: present ← absent	If `present`, will verify the resource is present and will create if needed. If `absent`, will verify the resource is absent and will delete if needed.
tags string		List of tags in Key:<user-defined key> Value:<user-defined value> format.
use_proxy boolean	Choices: no yes ←	If `no`, it will not use a proxy, even if one is defined in an environment variable on the target hosts.
validate_certs boolean	Choices: no yes ←	Boolean control for verifying the api_uri TLS certificate
vlan_id integer / required		VLAN to be used for server access over Inband network.

Examples

- name: Configure IMC Access policy
  intersight_imc_access_policy:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    name: sjc02-d23-access
    description: IMC access for SJC02 rack D23
    tags:
      - Site: D23
    vlan_id: 131
    ip_pool: sjc02-d23-ext-mgmt

- name: Delete IMC Access policy
  intersight_imc_access_policy:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    name: sjc02-d23-access
    state: absent

Return Values

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

Key	Returned	Description
api_repsonse dictionary	always	The API response output returned by the specified resource. Sample: {'api_response': {'Name': 'sjc02-d23-access', 'ObjectType': 'access.Policy', 'Profiles': [{'Moid': '5e4ec7ae77696e2d30840cfc', 'ObjectType': 'server.Profile'}, {'Moid': '5e84d78777696e2d302ec195', 'ObjectType': 'server.Profile'}], 'Tags': [{'Key': 'Site', 'Value': 'SJC02'}]}}

Authors

David Soper (@dsoper2)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/cisco/intersight/intersight_imc_access_policy_module.html