cisco.intersight.intersight_imc_access_policy (2.0.8) — module

Install collection

Install with ansible-galaxy collection install cisco.intersight:==2.0.8

Add to requirements.yml

  collections:
    - name: cisco.intersight
      version: 2.0.8

Description

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 L(Cisco Intersight,https://intersight.com/apidocs).

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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

Inputs

    
name:
    description:
    - The name assigned to the IMC Access Policy.
    - The name must be between 1 and 62 alphanumeric characters, allowing special characters
      :-_.
    required: true
    type: str

tags:
    description:
    - List of tags in Key:<user-defined key> Value:<user-defined value> format.
    elements: dict
    type: list

state:
    choices:
    - present
    - absent
    default: present
    description:
    - 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.
    type: str

api_uri:
    default: https://intersight.com/api/v1
    description:
    - URI used to access the Intersight API.
    - If not set, the value of the INTERSIGHT_API_URI environment variable is used.
    type: str

ip_pool:
    description:
    - IP Pool used to assign IP address and other required network settings.
    required: true
    type: str

vlan_id:
    description:
    - VLAN to be used for server access over Inband network.
    - Required if C(out_of_band) is C(false).
    type: int

use_proxy:
    default: true
    description:
    - If C(no), it will not use a proxy, even if one is defined in an environment variable
      on the target hosts.
    type: bool

api_key_id:
    description:
    - 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: true
    type: str

description:
    aliases:
    - descr
    description:
    - 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(_).
    type: str

out_of_band:
    default: false
    description:
    - If C(true), will enable Out-Of-Band configuration.
    - If C(false), will enable In-Band configuration.
    type: bool

organization:
    default: default
    description:
    - 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.
    type: str

validate_certs:
    default: true
    description:
    - Boolean control for verifying the api_uri TLS certificate
    type: bool

api_private_key:
    description:
    - 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: true
    type: path

Outputs

api_repsonse:
  description: The API response output returned by the specified resource.
  returned: always
  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
  type: dict