ucs_org – Manages UCS Organizations for UCS Manager — Ansible Documentation

- AnsibleFest
- Products
- Community
- Webinars & Training
- Blog

Documentation

# ucs_org – Manages UCS Organizations for UCS Manager

New in version 2.8.

- Synopsis
- Requirements
- Parameters
- Examples
- Status

## Synopsis

- Manages UCS Organizations for UCS Manager.
- Examples can be used with the UCS Platform Emulator https://cs.co/ucspe.

## Requirements

The below requirements are needed on the host that executes this module.

- ucsmsdk

## Parameters

Parameter | Choices/Defaults | Comments
--- | --- | ---
delegate_to string | Default: "localhost" | Where the module will be run
description string |  | A user-defined description of the organization. Enter up to 256 characters. You can use any characters or spaces except the following: ` (accent mark), (backslash), ^ (carat), " (double quote), = (equal sign), > (greater than), < (less than), or ' (single quote). aliases: descr
hostname string / required |  | IP address or hostname of Cisco UCS Manager.
org_name string |  | The name of the organization. Enter up to 16 characters. You can use any characters or spaces except the following: ` (accent mark), (backslash), ^ (carat), " (double quote), = (equal sign), > (greater than), < (less than), or ' (single quote). aliases: name
parent_org_path string | Default: "root" | A forward slash / separated hierarchical path from the root organization to the parent of the organization to be added or updated. UCS Manager supports a hierarchical structure of organizations up to five levels deep not including the root organization. For example the parent_org_path for an organization named level5 could be root/level1/level2/level3/level4/level5
password string / required |  | Password for Cisco UCS Manager authentication.
port integer |  | Port number to be used during connection (by default uses 443 for https and 80 for http connection).
proxy string |  | If use_proxy is no, specfies proxy to be used for connection. e.g. 'http://proxy.xy.z:8080'
state string | Choices: absent present ← | If `absent`, will remove organization. If `present`, will create or update organization.
use_proxy boolean | Choices: no yes ← | If `no`, will not use the proxy as defined by system environment variable.
use_ssl boolean | Choices: no yes ← | If `no`, an HTTP connection will be used instead of the default HTTPS connection.
username string | Default: "admin" | Username for Cisco UCS Manager authentication.

## Examples

    - name: Add UCS Organization
      ucs_org:
        hostname: "{{ ucs_hostname }}"
        username: "{{ ucs_username }}"
        password: "{{ ucs_password }}"
        org_name: test
        description: testing org
        state: present
        delegate_to: localhost

    - name: Update UCS Organization
      ucs_org:
        hostname: "{{ ucs_hostname }}"
        username: "{{ ucs_username }}"
        password: "{{ ucs_password }}"
        org_name: test
        description: Testing org
        state: present
        delegate_to: localhost

    - name: Add UCS Organization
      ucs_org:
        hostname: "{{ ucs_hostname }}"
        username: "{{ ucs_username }}"
        password: "{{ ucs_password }}"
        org_name: level1
        parent_org_path: root
        description: level1 org
        state: present
        delegate_to: localhost

    - name: Add UCS Organization
      ucs_org:
        hostname: "{{ ucs_hostname }}"
        username: "{{ ucs_username }}"
        password: "{{ ucs_password }}"
        org_name: level2
        parent_org_path: root/level1
        description: level2 org
        state: present

    - name: Add UCS Organization
      ucs_org:
        hostname: "{{ ucs_hostname }}"
        username: "{{ ucs_username }}"
        password: "{{ ucs_password }}"
        org_name: level3
        parent_org_path: root/level1/level2
        description: level3 org
        state: present

    - name: Remove UCS Organization
      ucs_org:
        hostname: "{{ ucs_hostname }}"
        username: "{{ ucs_username }}"
        password: "{{ ucs_password }}"
        org_name: level2
        parent_org_path: root/level1/
        state: absent

## Status

- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]

### Authors

- John McDonough (@movinalot)
- CiscoUcs (@CiscoUcs)

Hint

If you notice any issues in this documentation, you can edit this document to improve it.