intersight_organization

Organization configuration for Cisco Intersight

Collection: cisco.intersight

Full Name: cisco.intersight.intersight_organization

Synopsis

Organization 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 Organization.
description	string			The user-defined description for the Organization.
share_resources	bool		`false`	Enable this option to share resources with other Organizations. When C(true), use O(shared_orgs) to specify which Organizations to share with. Mutually exclusive with O(resource_groups).
resource_groups	list			List of Resource Group names to assign to the Organization. Resource Group names are resolved to their Moids automatically. Mutually exclusive with O(share_resources) and O(shared_orgs).
shared_orgs	list			List of Organization names to share resources with. Only valid when O(share_resources) is C(true). Organization names are resolved to their Moids automatically.

Example

yaml

- cisco.intersight.intersight_organization:
    api_key_id: '{{ api_key_id }}'
    api_private_key: '{{ api_private_key }}'
    description: My organization
    name: my-organization
    resource_groups:
        - my-resource-group
    state: present
  name: Create Organization with Resource Groups

- cisco.intersight.intersight_organization:
    api_key_id: '{{ api_key_id }}'
    api_private_key: '{{ api_private_key }}'
    description: Organization sharing resources
    name: shared-org
    share_resources: true
    shared_orgs:
        - other-org-1
        - other-org-2
    state: present
  name: Create Organization with shared resources

- cisco.intersight.intersight_organization:
    api_key_id: '{{ api_key_id }}'
    api_private_key: '{{ api_private_key }}'
    description: Simple organization
    name: simple-org
    state: present
  name: Create Organization without Resource Groups

- cisco.intersight.intersight_organization:
    api_key_id: '{{ api_key_id }}'
    api_private_key: '{{ api_private_key }}'
    name: my-organization
    state: absent
  name: Delete Organization