intersight_chassis_profile

Manage Chassis Profiles in Cisco Intersight

Collection: cisco.intersight

Full Name: cisco.intersight.intersight_chassis_profile

Synopsis

Manage Chassis Profiles in 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 Chassis Profile. The name must be between 1 and 64 alphanumeric characters, allowing special characters :-_.
description	string			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(_).
tags	list			List of tags in Key: Value: format.
assigned_chassis_name	string			The name of the chassis to assign to this profile. The module resolves the chassis name to a MOID via the C(/equipment/Chasses) API endpoint. If not provided, the profile will be created without a chassis assignment.
imc_access_policy	string			Name of IMC Access Policy to associate with this profile.
power_policy	string			Name of Power Policy to associate with this profile.
snmp_policy	string			Name of SNMP Policy to associate with this profile.
thermal_policy	string			Name of Thermal Policy to associate with this profile.

Example

yaml

- cisco.intersight.intersight_chassis_profile:
    api_key_id: '{{ api_key_id }}'
    api_private_key: '{{ api_private_key }}'
    description: Basic chassis profile
    name: Chassis-Profile-01
    organization: default
    state: present
    tags:
        - Key: Environment
          Value: Production
  name: Create a basic Chassis Profile

- cisco.intersight.intersight_chassis_profile:
    api_key_id: '{{ api_key_id }}'
    api_private_key: '{{ api_private_key }}'
    assigned_chassis_name: FOX2534P0GG
    description: Chassis profile with assignment and policies
    imc_access_policy: IMC-Access-Prod
    name: Chassis-Profile-02
    organization: default
    power_policy: Power-Grid-Redundancy
    snmp_policy: SNMP-Monitoring
    state: present
    thermal_policy: Thermal-Balanced
  name: Create a Chassis Profile with chassis assignment and policies

- cisco.intersight.intersight_chassis_profile:
    api_key_id: '{{ api_key_id }}'
    api_private_key: '{{ api_private_key }}'
    name: Chassis-Profile-01
    state: absent
  name: Delete a Chassis Profile