intersight_server_profile_derive

Derive Server Profiles from Templates in Cisco Intersight

Collection: cisco.intersight

Full Name: cisco.intersight.intersight_server_profile_derive

Synopsis

Derive Server Profiles from Templates 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.
organization	string		`default`	The name of the Organization this resource is assigned to.
template_name	string	yes		Name of the Server Profile Template to derive from. The template must exist in the specified organization.
profile_names	list	yes		List of Server Profile names to derive from the template. Each name must be unique within the organization.
state	string		`present`	If C(present), will derive profiles that do not exist and sync profiles that are out of sync with the template. If C(absent), will delete derived profiles. Choices: `present`, `absent`
force_sync	bool		`false`	When C(true), always sync existing derived profiles to the template, even if the profile appears to be in sync. When C(false), only sync profiles whose ConfigContext shows they are out of sync with the template.

Example

yaml

- cisco.intersight.intersight_server_profile_derive:
    api_key_id: '{{ api_key_id }}'
    api_private_key: '{{ api_private_key }}'
    organization: default
    profile_names:
        - SP-Derived-1
    template_name: My-Standard-Template
  name: Derive a single server profile from a template

- cisco.intersight.intersight_server_profile_derive:
    api_key_id: '{{ api_key_id }}'
    api_private_key: '{{ api_private_key }}'
    organization: default
    profile_names:
        - SP-Derived-1
        - SP-Derived-2
        - SP-Derived-3
    template_name: My-Standard-Template
  name: Derive multiple server profiles from a template

- cisco.intersight.intersight_server_profile_derive:
    api_key_id: '{{ api_key_id }}'
    api_private_key: '{{ api_private_key }}'
    force_sync: true
    profile_names:
        - SP-Derived-1
    template_name: My-Standard-Template
  name: Force sync derived profiles back to template

- cisco.intersight.intersight_server_profile_derive:
    api_key_id: '{{ api_key_id }}'
    api_private_key: '{{ api_private_key }}'
    profile_names:
        - SP-Derived-1
    state: absent
    template_name: My-Standard-Template
  name: Delete derived server profiles