cisco.intersight.intersight_chassis_profile module – Manage Chassis Profiles in Cisco Intersight
Note
This module is part of the cisco.intersight collection (version 2.18.0).
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_chassis_profile.
Synopsis
Create, update, and delete Chassis Profiles on Cisco Intersight.
For more information see Cisco Intersight.
This module does not manage deployment of the chassis profile.
Parameters
Parameter |
Comments |
|---|---|
Public API Key ID associated with the private key. If not set, the value of the INTERSIGHT_API_KEY_ID environment variable is used. |
|
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. |
|
URI used to access the Intersight API. If not set, the value of the INTERSIGHT_API_URI environment variable is used. Default: |
|
The name of the chassis to assign to this profile. The module resolves the chassis name to a MOID via the If not provided, the profile will be created without a chassis assignment. |
|
The user-defined description of the Chassis Profile. Description can contain letters(a-z, A-Z), numbers(0-9), hyphen(-), period(.), colon(:), or an underscore(_). |
|
Name of IMC Access Policy to associate with this profile. |
|
The name assigned to the Chassis Profile. The name must be between 1 and 62 alphanumeric characters, allowing special characters :-_. |
|
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. Default: |
|
Name of Power Policy to associate with this profile. |
|
Name of SNMP Policy to associate with this profile. |
|
If If Choices:
|
|
List of tags in Key:<user-defined key> Value:<user-defined value> format. |
|
Name of Thermal Policy to associate with this profile. |
|
If Choices:
|
|
Boolean control for verifying the api_uri TLS certificate Choices:
|
Examples
- name: Create a basic Chassis Profile
cisco.intersight.intersight_chassis_profile:
api_private_key: "{{ api_private_key }}"
api_key_id: "{{ api_key_id }}"
organization: "default"
name: "Chassis-Profile-01"
description: "Basic chassis profile"
tags:
- Key: "Environment"
Value: "Production"
state: present
- name: Create a Chassis Profile with chassis assignment and policies
cisco.intersight.intersight_chassis_profile:
api_private_key: "{{ api_private_key }}"
api_key_id: "{{ api_key_id }}"
organization: "default"
name: "Chassis-Profile-02"
description: "Chassis profile with assignment and policies"
assigned_chassis_name: "FOX2534P0GG"
imc_access_policy: "IMC-Access-Prod"
power_policy: "Power-Grid-Redundancy"
snmp_policy: "SNMP-Monitoring"
thermal_policy: "Thermal-Balanced"
state: present
- name: Delete a Chassis Profile
cisco.intersight.intersight_chassis_profile:
api_private_key: "{{ api_private_key }}"
api_key_id: "{{ api_key_id }}"
name: "Chassis-Profile-01"
state: absent
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
The API response output returned by the specified resource. Returned: always Sample: |