cisco.intersight.intersight_imc_access_policy – IMC Access Policy configuration for Cisco Intersight
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.9).
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
- 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. | |
api_private_key path / required |
Filename (absolute path) of a PEM formatted file that contains your private key to be used for Intersight API authentication. | |
api_uri string |
Default: |
URI used to access the Intersight API. |
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(_).
| |
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 |
|
If If |
tags string |
List of tags in Key: Value: format. | |
use_proxy boolean |
|
If |
validate_certs boolean |
|
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–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/cisco/intersight/intersight_imc_access_policy_module.html