File: //opt/saltstack/salt/lib/python3.10/site-packages/salt/proxy/__pycache__/cimc.cpython-310.pyc
o
�N�g $ � @ s� d Z ddlZddlZddlm mZ ddlZdgZ ddiZ
i Z e� e
�ZdZdd� Zd!dd �Zd
d � Zd"d
d�Zd#dd�Zdd� Zd!dd�Zdd� Zdd� Zdd� Zdd � Zd d � Zd d � Z dS )$a
Proxy Minion interface module for managing Cisco Integrated Management Controller devices
=========================================================================================
.. versionadded:: 2018.3.0
:codeauthor: ``Spencer Ervin <spencer_ervin@hotmail.com>``
:maturity: new
:depends: none
:platform: unix
This proxy minion enables Cisco Integrated Management Controller devices (hereafter referred to
as simply 'cimc' devices to be treated individually like a Salt Minion.
The cimc proxy leverages the XML API functionality on the Cisco Integrated Management Controller.
The Salt proxy must have access to the cimc on HTTPS (tcp/443).
More in-depth conceptual reading on Proxy Minions can be found in the
:ref:`Proxy Minion <proxy-minion>` section of Salt's
documentation.
Configuration
=============
To use this integration proxy module, please configure the following:
Pillar
------
Proxy minions get their configuration from Salt's Pillar. Every proxy must
have a stanza in Pillar and a reference in the Pillar top-file that matches
the ID.
.. code-block:: yaml
proxy:
proxytype: cimc
host: <ip or dns name of cimc host>
username: <cimc username>
password: <cimc password>
verify_ssl: True
proxytype
^^^^^^^^^
The ``proxytype`` key and value pair is critical, as it tells Salt which
interface to load from the ``proxy`` directory in Salt's install hierarchy,
or from ``/srv/salt/_proxy`` on the Salt Master (if you have created your
own proxy module, for example). To use this cimc Proxy Module, set this to
``cimc``.
host
^^^^
The location, or ip/dns, of the cimc host. Required.
username
^^^^^^^^
The username used to login to the cimc host. Required.
password
^^^^^^^^
The password used to login to the cimc host. Required.
� NZcimc�vendorZCiscoc C s t S )z7
Only return if all the modules are available.
)�__virtualname__� r r �C/opt/saltstack/salt/lib/python3.10/site-packages/salt/proxy/cimc.py� __virtual__Y s r c C s8 t | �}|dvr|rt|� t�d|� tj�d��d S )N)Z200Z201Z202Z204z#Received error HTTP status code: %sz+Did not receive a valid response from host.)�str�logout�log�error�salt�
exceptions�CommandExecutionError)Zresponse_code_to_checkZcookie_to_logoutZformatted_response_coder r r �_validate_response_code` s ��r c C s� t �d| � d| d vrt �d� dS d| d vr t �d� dS d| d vr-t �d � dS d
�| d d �td < d d
dd�td< | d d td< | d �d�td< | d �d�td< | d �d�}|du rgd}|td< t �d� td� t �d� dtd< dS )z=
This function gets called when the proxy starts up.
z=== opts %s ===�host�proxyz-No 'host' key found in pillar for this proxy.F�usernamez1No 'username' key found in pillar for this proxy.�passwordz2No 'passwords' key found in pillar for this proxy.zhttps://{}/nuova�urlz!application/x-www-form-urlencoded�> zlwp-request/2.06)z Content-TypezContent-Lengthz
USER-Agent�headers�
verify_sslNTz)Attempting to connect to cimc proxy host.�computeRackUnitz*Successfully connected to cimc proxy host.� initialized)r �debug�critical�format�DETAILS�get�get_config_resolver_class)�optsr r r r �initk s4
�
r Fc C s� i }t � }d}|du r
d}d�||| |�}td td |dddtd ddtd
d � }t|d |� t�d
|d �d }t�|�} t |� | D ] }
t
|
�||
j < qF|S )zp
The configConfMo method configures the specified managed object in a single subtree (for example, DN).
�falseT�truez\<configConfMo cookie="{}" inHierarchical="{}" dn="{}"><inConfig>{}</inConfig></configConfMo>�
http.queryr �POST�plainr r ��data�method� decode_type�decoder � raise_error�statusr r, � (<[\s\S.]*>)�textr � �logonr � __utils__r r �re�findall�ET�
fromstringr �prepare_return�tag) �dnZinconfig� hierarchical�ret�cookie�h�payload�r�answer�items�itemr r r �set_config_modify� s4 ��
rB c
C s� i }t � }d}|du r
d}d�||| �}td td |dddtd ddtd
d � }t|d |� t�d
|d �d }t�|�}t |� |D ] } t
| �|| j < qE|S )zZ
The configResolveClass method returns requested managed object in a given class.
r! Tr" zB<configResolveClass cookie="{}" inHierarchical="{}" classId="{}"/>r# r r$ r% r r r& r, r- r. r r/ )
Zcidr9 r: r; r< r= r> r? r@ rA r r r r � s6 ���
r c C s� i } d� td td �}td td |dddtd d
dtd d � }t|d
� t�d|d �d }t�|�}|jD ] }|j| | |< q9d| vrMt j
� d��| d S )zC
Logs into the cimc device and returns the session cookie.
z1<aaaLogin inName='{}' inPassword='{}'></aaaLogin>r r r# r r$ r% Tr Fr r& r, r- r. r Z outCookiez Unable to log into proxy device.) r r r1 r r2 r3 r4 r5 �attribr r r
)�contentr= r> r? r@ rA r r r r0 � s. ��
r0 c
C s6 d� | �}td td |dddtd dtd d � d
S ) z-
Closes the session with the device.
z3<aaaLogout cookie="{0}" inCookie="{0}"></aaaLogout>r# r r$ r% Tr r )r' r( r) r* r r+ r N)r r1 r )r; r= r r r r s
�
r c C sX i }t | �D ]}|j|vrg ||j< ||j �t|�� q| jD ] }| j| ||< q |S )z$
Converts the etree to dict
)�listr7 �appendr6 rC )�xr: �ar r r r6 s
r6 c C s t �dd�S )z�
Since grains are loaded in many different places and some of those
places occur before the proxy can be initialized, return whether
our init() function has been called
r F)r r r r r r r ! s r c
C s� t �di �sDtt d< ztdd�} | d d t d< W t d S tjjy* Y t d S tyC } zt� |� W Y d}~t d S d}~ww t d S )z0
Get the grains from the proxied device
� grains_cacher FZ
outConfigsN)
r r � GRAINS_CACHEr r r r
� Exceptionr r
)Z compute_rack�errr r r �grains* s
����rM c C s dt d< t� S )z4
Refresh the grains from the proxied device
NrI )r rM r r r r �grains_refresh: s rN c
C s\ z
t � } t| � W dS tjjy Y dS ty- } z t�|� W Y d}~dS d}~ww )z>
Returns true if the device is reachable, else false.
FNT)r0 r r r r
rK r r )r; rL r r r �pingB s
�
��rO c C s t �d� dS )z_
Shutdown the connection to the proxy device. For this proxy,
shutdown is a no-op.
z CIMC proxy shutdown() called.N)r r r r r r �shutdownQ s rP )N)NNF)NF) �__doc__�loggingr2 Zxml.etree.ElementTreeZetreeZ ElementTreer4 Zsalt.exceptionsr Z__proxyenabled__rJ r � getLogger�__file__r r r r r rB r r0 r r6 r rM rN rO rP r r r r �<module> s. D
'
&(
!