intersight_imc_access_policy

IMC Access Policy configuration for Cisco Intersight

Collection: cisco.intersight

Full Name: cisco.intersight.intersight_imc_access_policy

Synopsis

IMC Access Policy configuration for Cisco Intersight

Parameters

Name	Type	Required	Default	Description
api_private_key	string			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—– —–END EC PRIVATE KEY—–’ If not set, the value of the INTERSIGHT_API_PRIVATE_KEY environment variable is used. Required if I(api_bearer_token) is not provided. Secret value; omitted from logs and results.
api_uri	string		`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.
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 I(api_bearer_token) is not provided.
api_bearer_token	string			Bearer token for OAuth2 authentication with the Intersight API. When provided, I(api_key_id) and I(api_private_key) are not required and the C(cryptography) Python library is not needed. If not set, the value of the INTERSIGHT_API_BEARER_TOKEN environment variable is used. Secret value; omitted from logs and results.
validate_certs	bool		`true`	Boolean control for verifying the api_uri TLS certificate
use_proxy	bool		`true`	If C(no), it will not use a proxy, even if one is defined in an environment variable on the target hosts.
state	string		`present`	If C(present), will verify the resource is present and will create if needed. If C(absent), will verify the resource is absent and will delete if needed. Choices: `present`, `absent`
organization	string		`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.
name	string	yes		The name assigned to the IMC Access Policy. The name must be between 1 and 64 alphanumeric characters, allowing special characters :-_.
description	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(_).
tags	list			List of tags in Key: Value: format.
out_of_band	bool		`false`	If C(true), will enable Out-Of-Band configuration. If C(false), will enable In-Band configuration.
vlan_id	int			VLAN to be used for server access over Inband network. Required if C(out_of_band) is C(false).
ip_pool	raw			IP Pool used to assign IP address and other required network settings. Required when C(state=present). May be provided as a string pool name in the same organization as the policy. May also be provided as a dictionary with C(name) and optional C(organization). Dictionary field C(name) is the name of the IP Pool used to assign IP address and other required network settings. Dictionary field C(organization) is the name of the Organization that owns the IP Pool. Dictionary field C(organization) defaults to the value of C(organization) when omitted. Set dictionary field C(organization) when the IMC Access Policy should consume an IP Pool from a different Organization.

Example

yaml

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

- intersight_imc_access_policy:
    api_key_id: '{{ api_key_id }}'
    api_private_key: '{{ api_private_key }}'
    ip_pool:
        name: sjc02-d23-ext-mgmt
    name: sjc02-d23-access
    vlan_id: 131
  name: Configure IMC Access policy using dictionary form for ip_pool

- intersight_imc_access_policy:
    api_key_id: '{{ api_key_id }}'
    api_private_key: '{{ api_private_key }}'
    ip_pool:
        name: shared-ext-mgmt
        organization: shared-org
    name: sjc02-d23-access
    organization: policy-org
    vlan_id: 131
  name: Configure IMC Access policy with IP pool from another organization

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