cisco.intersight.intersight_rest_api – REST API configuration for Cisco Intersight
cisco.intersight.intersight_rest_api – REST API 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_rest_api
.
New in version 2.8: of cisco.intersight
Synopsis
- Direct REST API configuration for Cisco Intersight.
- All REST API resources and properties must be specified.
- For more information see Cisco Intersight.
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
api_body dictionary |
The paylod for API requests used to modify resources. | |
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. |
query_params dictionary |
Query parameters for the Intersight API query languange. | |
resource_path string / required |
Resource URI being configured related to api_uri. | |
return_list boolean |
|
If By default only the 1st element of the API Results list is returned. Can only be used with GET operations. |
state string |
|
If If |
update_method string |
|
The HTTP method used for update operations. Some Intersight resources require POST operations for modifications. |
use_proxy boolean |
|
If |
validate_certs boolean |
|
Boolean control for verifying the api_uri TLS certificate |
Examples
- name: Configure Boot Policy
intersight_rest_api:
api_private_key: "{{ api_private_key }}"
api_key_id: "{{ api_key_id }}"
api_key_uri: "{{ api_key_uri }}"
validate_certs: "{{ validate_certs }}"
resource_path: /boot/PrecisionPolicies
query_params:
$filter: "Name eq 'vmedia-localdisk'"
api_body: {
"Name": "vmedia-localdisk",
"ConfiguredBootMode": "Legacy",
"BootDevices": [
{
"ObjectType": "boot.VirtualMedia",
"Enabled": true,
"Name": "remote-vmedia",
"Subtype": "cimc-mapped-dvd"
},
{
"ObjectType": "boot.LocalDisk",
"Enabled": true,
"Name": "localdisk",
"Slot": "MRAID",
"Bootloader": null
}
],
}
state: present
- name: Delete Boot Policy
intersight_rest_api:
api_private_key: "{{ api_private_key }}"
api_key_id: "{{ api_key_id }}"
api_key_uri: "{{ api_key_uri }}"
validate_certs: "{{ validate_certs }}"
resource_path: /boot/PrecisionPolicies
query_params:
$filter: "Name eq 'vmedia-localdisk'"
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': {'BootDevices': [{'Enabled': True, 'Name': 'remote-vmedia', 'ObjectType': 'boot.VirtualMedia', 'Subtype': 'cimc-mapped-dvd'}, {'Bootloader': None, 'Enabled': True, 'Name': 'boot-lun', 'ObjectType': 'boot.LocalDisk', 'Slot': 'MRAID'}], 'ConfiguredBootMode': 'Legacy', 'Name': 'vmedia-localdisk', 'ObjectType': 'boot.PrecisionPolicy'}} |
Authors
- David Soper (@dsoper2)
- CiscoUcs (@CiscoUcs)
© 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_rest_api_module.html