intersight_resource_group

Resource Group configuration for Cisco Intersight

Collection: cisco.intersight

Full Name: cisco.intersight.intersight_resource_group

Synopsis

Resource Group configuration for 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`
name	string	yes		The name assigned to the Resource Group. The name must be between 1 and 64 alphanumeric characters, allowing special characters :-_.
description	string			The user-defined description for the Resource Group.
tags	list			List of tags in Key: Value: format.
resources	list			List of Intersight-managed UCS domain resources to include in the Resource Group. Required when O(state) is C(present). Each entry specifies a domain by its target name as shown in the Intersight GUI Targets page. When O(resources[].sub_targets) is provided, only the specified servers (by serial number) are included instead of the full domain. Multiple entries can be mixed, some with sub-targets and some without. Nested options: domain_name (str) required; sub_targets (list)

Example

yaml

- cisco.intersight.intersight_resource_group:
    api_key_id: '{{ api_key_id }}'
    api_private_key: '{{ api_private_key }}'
    description: Resource group for two UCS domains
    name: ucs-domains-group
    resources:
        - domain_name: ucs-domain-1
        - domain_name: ucs-domain-2
    state: present
  name: Create Resource Group for full UCS domains

- cisco.intersight.intersight_resource_group:
    api_key_id: '{{ api_key_id }}'
    api_private_key: '{{ api_private_key }}'
    description: Only specific servers from the domain
    name: specific-servers-group
    resources:
        - domain_name: ucs-domain-1
          sub_targets:
            - FCH26387BD1
            - FCH243974ZD
            - WZP26030TAV
    state: present
  name: Create Resource Group with sub-targets (specific servers)

- cisco.intersight.intersight_resource_group:
    api_key_id: '{{ api_key_id }}'
    api_private_key: '{{ api_private_key }}'
    description: Full domain and specific servers from another
    name: mixed-resources-group
    resources:
        - domain_name: ucs-domain-1
        - domain_name: ucs-domain-2
          sub_targets:
            - FCH26387BD1
            - WZP26030TAV
    state: present
  name: Create Resource Group with mixed resources

- cisco.intersight.intersight_resource_group:
    api_key_id: '{{ api_key_id }}'
    api_private_key: '{{ api_private_key }}'
    name: ucs-domains-group
    state: absent
  name: Delete Resource Group