cisco.intersight.intersight_organization module – Organization configuration for 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_organization.

Synopsis

  • Manages Organization configuration on Cisco Intersight.

  • Organizations are account-level resources used to organize and manage Intersight resources.

  • Supports assigning Resource Groups to define resource scope.

  • Supports sharing resources with other Organizations via sharing rules.

  • For more information see Cisco Intersight.

Parameters

Parameter

Comments

api_key_id

string / required

Public API Key ID associated with the private key.

If not set, the value of the INTERSIGHT_API_KEY_ID environment variable is used.

api_private_key

path / required

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.

api_uri

string

URI used to access the Intersight API.

If not set, the value of the INTERSIGHT_API_URI environment variable is used.

Default: "https://intersight.com/api/v1"

description

aliases: descr

string

The user-defined description for the Organization.

name

string / required

The name assigned to the Organization.

resource_groups

list / elements=string

List of Resource Group names to assign to the Organization.

Resource Group names are resolved to their Moids automatically.

Mutually exclusive with share_resources and shared_orgs.

share_resources

boolean

Enable this option to share resources with other Organizations.

When true, use shared_orgs to specify which Organizations to share with.

Mutually exclusive with resource_groups.

Choices:

  • false ← (default)

  • true

shared_orgs

list / elements=string

List of Organization names to share resources with.

Only valid when share_resources is true.

Organization names are resolved to their Moids automatically.

state

string

If present, will verify the resource is present and will create if needed.

If absent, will verify the resource is absent and will delete if needed.

Choices:

  • "present" ← (default)

  • "absent"

use_proxy

boolean

If no, it will not use a proxy, even if one is defined in an environment variable on the target hosts.

Choices:

  • false

  • true ← (default)

validate_certs

boolean

Boolean control for verifying the api_uri TLS certificate

Choices:

  • false

  • true ← (default)

Examples

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

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

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

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

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

api_response

dictionary

The API response output returned by the specified resource.

Returned: always

Sample: {"api_response": {"Description": "My organization", "Name": "my-organization", "ObjectType": "organization.Organization"}}

Authors

  • Ron Gershburg (@rgershbu)