Vh< @ d dl mZmZmZ eZdZdZdZd dl Z d dl
Z
dZ d dl Z
dZdZ d dlmZ dZd d lmZmZ d d
lmZ d d lmZ d d l m Z dd
Z d Z d Z d Z!e"dk( r e! yy# e$ r e
j Z dZY Zw xY w# e$ r e
j ZdZY mw xY w) )absolute_importdivisionprint_functiona*
module: imc_rest
short_description: Manage Cisco IMC hardware through its REST API
description:
- Provides direct access to the Cisco IMC REST API.
- Perform any configuration changes and actions that the Cisco IMC supports.
- More information about the IMC REST API is available from
U(http://www.cisco.com/c/en/us/td/docs/unified_computing/ucs/c/sw/api/3_0/b_Cisco_IMC_api_301.html).
author:
- Dag Wieers (@dagwieers)
requirements:
- lxml
- xmljson >= 0.1.8
extends_documentation_fragment:
- community.general.attributes
attributes:
check_mode:
support: full
diff_mode:
support: none
options:
hostname:
description:
- IP Address or hostname of Cisco IMC, resolvable by Ansible control host.
required: true
aliases: [host, ip]
type: str
username:
description:
- Username used to login to the switch.
default: admin
aliases: [user]
type: str
password:
description:
- The password to use for authentication.
default: password
type: str
path:
description:
- Name of the absolute path of the filename that includes the body of the http request being sent to the Cisco IMC REST
API.
- Parameter O(path) is mutual exclusive with parameter O(content).
aliases: ['src', 'config_file']
type: path
content:
description:
- When used instead of O(path), sets the content of the API requests directly.
- This may be convenient to template simple requests, for anything complex use the M(ansible.builtin.template) module.
- You can collate multiple IMC XML fragments and they will be processed sequentially in a single stream, the Cisco IMC
output is subsequently merged.
- Parameter O(content) is mutual exclusive with parameter O(path).
type: str
protocol:
description:
- Connection protocol to use.
default: https
choices: [http, https]
type: str
timeout:
description:
- The socket level timeout in seconds.
- This is the time that every single connection (every fragment) can spend. If this O(timeout) is reached, the module
will fail with a C(Connection failure) indicating that C(The read operation timed out).
default: 60
type: int
validate_certs:
description:
- If V(false), SSL certificates will not be validated.
- This should only set to V(false) used on personally controlled sites using self-signed certificates.
type: bool
default: true
notes:
- The XML fragments do not need an authentication cookie, this is injected by the module automatically.
- The Cisco IMC XML output is being translated to JSON using the Cobra convention.
- Any configConfMo change requested has a return status of C(modified), even if there was no actual change from the previous
configuration. As a result, this module will always report a change on subsequent runs. In case this behaviour is fixed
in a future update to Cisco IMC, this module will automatically adapt.
- If you get a C(Connection failure) related to C(The read operation timed out) increase the O(timeout) parameter. Some
XML fragments can take longer than the default timeout.
- More information about the IMC REST API is available from
U(http://www.cisco.com/c/en/us/td/docs/unified_computing/ucs/c/sw/api/3_0/b_Cisco_IMC_api_301.html).
a
- name: Power down server
community.general.imc_rest:
hostname: '{{ imc_hostname }}'
username: '{{ imc_username }}'
password: '{{ imc_password }}'
validate_certs: false # only do this when you trust the network!
content: |
delegate_to: localhost
- name: Configure IMC using multiple XML fragments
community.general.imc_rest:
hostname: '{{ imc_hostname }}'
username: '{{ imc_username }}'
password: '{{ imc_password }}'
validate_certs: false # only do this when you trust the network!
timeout: 120
content: |
delegate_to: localhost
- name: Enable PXE boot and power-cycle server
community.general.imc_rest:
hostname: '{{ imc_hostname }}'
username: '{{ imc_username }}'
password: '{{ imc_password }}'
validate_certs: false # only do this when you trust the network!
content: |
delegate_to: localhost
- name: Reconfigure IMC to boot from storage
community.general.imc_rest:
hostname: '{{ imc_host }}'
username: '{{ imc_username }}'
password: '{{ imc_password }}'
validate_certs: false # only do this when you trust the network!
content: |
delegate_to: localhost
- name: Add customer description to server
community.general.imc_rest:
hostname: '{{ imc_host }}'
username: '{{ imc_username }}'
password: '{{ imc_password }}'
validate_certs: false # only do this when you trust the network!
content: |
delegate_to: localhost
- name: Disable HTTP and increase session timeout to max value 10800 secs
community.general.imc_rest:
hostname: '{{ imc_host }}'
username: '{{ imc_username }}'
password: '{{ imc_password }}'
validate_certs: false # only do this when you trust the network!
timeout: 120
content: |
delegate_to: localhost
a
aaLogin:
description: Cisco IMC XML output for the login, translated to JSON using Cobra convention.
returned: success
type: dict
sample: |
"attributes": {
"cookie": "",
"outCookie": "1498902428/9de6dc36-417c-157c-106c-139efe2dc02a",
"outPriv": "admin",
"outRefreshPeriod": "600",
"outSessionId": "114",
"outVersion": "2.0(13e)",
"response": "yes"
}
configConfMo:
description: Cisco IMC XML output for any configConfMo XML fragments, translated to JSON using Cobra convention.
returned: success
type: dict
sample: |
elapsed:
description: Elapsed time in seconds.
returned: always
type: int
sample: 31
response:
description: HTTP response message, including content length.
returned: always
type: str
sample: OK (729 bytes)
status:
description: The HTTP response status code.
returned: always
type: dict
sample: 200
error:
description: Cisco IMC XML error output for last request, translated to JSON using Cobra convention.
returned: failed
type: dict
sample: |
"attributes": {
"cookie": "",
"errorCode": "ERR-xml-parse-error",
"errorDescr": "XML PARSING ERROR: Element 'computeRackUnit', attribute 'admin_Power': The attribute 'admin_Power' is not allowed. ",
"invocationResult": "594",
"response": "yes"
}
error_code:
description: Cisco IMC error code.
returned: failed
type: str
sample: ERR-xml-parse-error
error_text:
description: Cisco IMC error message.
returned: failed
type: str
sample: |
XML PARSING ERROR: Element 'computeRackUnit', attribute 'admin_Power': The attribute 'admin_Power' is not allowed.
input:
description: RAW XML input sent to the Cisco IMC, causing the error.
returned: failed
type: str
sample: |
output:
description: RAW XML output received from the Cisco IMC, with error details.
returned: failed
type: str
sample: >
NTF)cobra)
AnsibleModulemissing_required_lib) zip_longest fetch_url)nowc H t j j | }t j | }|j d r\|j d rK|r||d< ||d< |j d |d< |j d |d< | j d dd|z i| |S )
z Handle IMC returned data errorCode
errorDescrinputoutput
error_code
error_textmsgz Request failed: %(error_text)s )lxmletree
fromstringr dataget fail_json)module rawoutputrawinput xmloutputresults n/home/dcms/DCMS/lib/python3.12/site-packages/ansible_collections/community/general/plugins/modules/imc_rest.py imc_responser" ) s
%%i0I
ZZ
"F }}[!immL&A &F7O$x (}}[ 9| (}}\ :| Q = FQ&Q M c < d|d|d}t | ||d| \ }}y)z Perform a logout, if needed zPOSTr methodtimeoutNr
)r urlcookier) r respauths r! logoutr. : s" 7=v FD63T&'RJD$r# c t | t rZt |t rJt | }|j |D ci c]" }|t | j |d || $ c} |S t | t
r9t |t
r)t
| | D cg c] \ }}t || c}}S || S |S c c}w c c}}w )z1 Merge two complex nested datastructures into oneN)
isinstancedictupdatemerger listr )onetwocopykeyalphabetas r! r3 r3 @ s #t C!6Cy M#S%T 2CH==MN C :c4#88CC8MN}teT"NN+3&3&
N Os 'B:B?c N t t t ddddg t dddg t dd d
t d t d d
dg t ddddg t dd t dd ddd gg } t s | j t d t
t s | j t d t | j d }| j d }| j d }| j d }| j d }| j d }| j d }t d!d!" }d!} |r7t j j | rd} n| j d#|z $ t }
|d%|d&} d'|d(|d)} t | | | d*|+ \ }
}|
|d, d-k7 r1t |
z
j |d.< | j d?d/d0|z i| |j t! | |
j# d1} |d2 d3 d4 } |r|}n'| r%t' |d6 5 }|j# }d d d t( j* j- d7j/ d8d1 z }t1 | D ] }|j2 t( j* j4 u r+|j7 d9| t( j* j9 | } t | | | d*|+ \ }
}|
|d, d-k7 r1t |
z
j |d.< | j d?d/d0|z i| |
j# }t; |t! | || : }|d/ |d;< |d, |d,< t( j* j- | }|j= d< }d=|v |d>< t |
z
j |d.< | j> d?i | tA | | || y # t$ $ r | j d?d/d5i| Y w xY w# 1 sw Y xY w# tA | | || w xY w)@NstrThostip)typerequiredaliasesadminuser)r? defaultrA password)r? rD no_log)r? path config_filesrc)r? rA httpshttp)r? rD choicesint< )r? rD bool)hostnameusernamerE contentrG protocolr) validate_certsrR )
argument_specsupports_check_modemutually_exclusiver )r exceptionzxmljson >= 0.1.8rP rQ rS r) F)failedchangedzCannot find/access path:
%s)r z://z/nuovaz>$ K !?$!F G EE &x
0C8@( KD63T&'RJD$ |tH~, UU] 3 3y[ ID P[TZ[
MM,vtyy{34 FJ
#L1+>)- G
dC
/M',,.
/ **''(9GOODRTI&IJ
/
/H vsFG,s7 O# #P 6PF
P # PPP P P$__main__)r^ )#
__future__r r r r?
__metaclass__
DOCUMENTATIONEXAMPLESRETURNrk tracebackrg
lxml.etreer rf ImportError
format_excri xmljsonr rh ansible.module_utils.basicr r ansible.module_utils.six.movesr ansible.module_utils.urlsr Cansible_collections.community.general.plugins.module_utils.datetimer r" r. r3 r __name__r r# r! r s A @
R
h` DJ
X
N
K 6 /
"S
'h-V zF I ---/N 0I 0 0 2 s" A$ B $A?>A?B B