On this page
cisco.ucs.ucs_graphics_card_policy – Manages UCS Graphics Card Policies on UCS Manager
Note
This plugin is part of the cisco.ucs collection (version 1.6.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.ucs.
To use it in a playbook, specify: cisco.ucs.ucs_graphics_card_policy.
New in version 2.9: of cisco.ucs
Synopsis
- Manages UCS Graphics Card Policies on UCS Manager.
 
Requirements
The below requirements are needed on the host that executes this module.
- ucsmsdk
 
Parameters
| Parameter | Choices/Defaults | Comments | 
|---|---|---|
| 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), ' (single quote).
        
       aliases: descr  | 
     |
| graphics_card_mode
        
        string
         | 
      
       
  | 
      
        
        Set the Graphics Card Mode.
         | 
     
| hostname
        
        string / required
         | 
      
        
        IP address or hostname of Cisco UCS Manager.
        
       
        Modules can be used with the UCS Platform Emulator https://cs.co/ucspe
         | 
     |
| name
        
        string / required
         | 
      
        
        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), ' (single quote).
         | 
     |
| org_dn
        
        string
         | 
      Default: 
        "org-root"
         | 
      
        
        Org dn (distinguished name)
         | 
     
| 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
         | 
      
       
  | 
      
        
        If  
       absent, will remove organization.
       
        If  present, will create or update organization.
        | 
     
| use_proxy
        
        boolean
         | 
      
       
  | 
      
        
        If  no, will not use the proxy as defined by system environment variable.
        | 
     
| use_ssl
        
        boolean
         | 
      
       
  | 
      
        
        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 Graphics Card Policy
  cisco.ucs.ucs_graphics_card_policy:
    hostname: "{{ ucs_hostname }}"
    username: "{{ ucs_username }}"
    password: "{{ ucs_password }}"
    state: present
    description: Any Graphics Mode Policy
    name: any_graphics
    graphics_card_mode: any-configuration
  delegate_to: localhost
- name: Add UCS Graphics Card Policy in an Organization
  cisco.ucs.ucs_graphics_card_policy:
    hostname: "{{ ucs_hostname }}"
    username: "{{ ucs_username }}"
    password: "{{ ucs_password }}"
    state: present
    org_dn: org-root/org-prod
    description: Any Graphics Mode Policy
    name: prod_graphics
    graphics_card_mode: any-configuration
  delegate_to: localhost
- name: Update UCS Graphics Card Policy in an Organization
  cisco.ucs.ucs_graphics_card_policy:
    hostname: "{{ ucs_hostname }}"
    username: "{{ ucs_username }}"
    password: "{{ ucs_password }}"
    state: present
    org_dn: org-root/org-prod
    description: Graphics Mode Policy
    name: prod_graphics
    graphics_card_mode: graphics
  delegate_to: localhost
- name: Update UCS Graphics Card Policy in an Organization
  cisco.ucs.ucs_graphics_card_policy:
    hostname: "{{ ucs_hostname }}"
    username: "{{ ucs_username }}"
    password: "{{ ucs_password }}"
    state: present
    org_dn: org-root/org-prod
    description: Compute Mode Policy
    name: prod_graphics
    graphics_card_mode: compute
  delegate_to: localhost
- name: Delete UCS Graphics Card Policy in an Organization
  cisco.ucs.ucs_graphics_card_policy:
    hostname: "{{ ucs_hostname }}"
    username: "{{ ucs_username }}"
    password: "{{ ucs_password }}"
    state: absent
    org_dn: org-root/org-prod
    name: prod_graphics
  delegate_to: localhost
- name: Delete UCS Graphics Card Policy
  cisco.ucs.ucs_graphics_card_policy:
    hostname: "{{ ucs_hostname }}"
    username: "{{ ucs_username }}"
    password: "{{ ucs_password }}"
    state: absent
    name: any_graphics
  delegate_to: localhost
  Authors
- John McDonough (@movinalot)
 
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
 https://docs.ansible.com/ansible/latest/collections/cisco/ucs/ucs_graphics_card_policy_module.html