Current File : //lib/python2.7/site-packages/salt/modules/cimc.pyc
�
���^c @@ s d Z d d l m Z m Z m Z d d l Z d d l Z d d l Z e j e
� Z d Z d � Z
e d � Z d d d d d � Z d � Z d � Z d
� Z d � Z d � Z d
� Z d � Z d � Z d � Z d � Z d � Z d � Z d � Z d � Z d � Z d � Z! d � Z" d � Z# d � Z$ d � Z% d � Z& d � Z' d � Z( d � Z) d � Z* d d d d! d d d" � Z+ d# � Z, d d$ � Z- d d d% � Z. d& d& d& d& d' � Z/ d d d d( � Z0 d d) d* � Z1 d d d d d d+ � Z2 d d d, � Z3 d d d- � Z4 d S(. u�
Module to provide Cisco UCS compatibility to Salt
:codeauthor: ``Spencer Ervin <spencer_ervin@hotmail.com>``
:maturity: new
:depends: none
:platform: unix
Configuration
=============
This module accepts connection configuration details either as
parameters, or as configuration settings in pillar as a Salt proxy.
Options passed into opts will be ignored if options are passed into pillar.
.. seealso::
:py:mod:`Cisco UCS Proxy Module <salt.proxy.cimc>`
About
=====
This execution module was designed to handle connections to a Cisco UCS server.
This module adds support to send connections directly to the device through the
rest API.
i ( t absolute_importt print_functiont unicode_literalsNu cimcc C@ sL y. t j j j � r- t d d d k r- t SWn t k
rA n Xt d f S( u/
Will load for the cimc proxy minions.
u proxyu proxytypeu cimcuD The cimc execution module can only be loaded for cimc proxy minions.( t saltt utilst platformt is_proxyt __opts__t __virtualname__t KeyErrort False( ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/cimc.pyt __virtual__) s
c C@ sJ d } d } | t k r! d } n d j | � } t d | | t � } | S( u
Activates the firmware backup image.
CLI Example:
Args:
reset(bool): Reset the CIMC device on activate.
.. code-block:: bash
salt '*' cimc.activate_backup_image
salt '*' cimc.activate_backup_image reset=True
u2 sys/rack-unit-1/mgmt/fw-boot-def/bootunit-combinedu nou yesu� <firmwareBootUnit dn='sys/rack-unit-1/mgmt/fw-boot-def/bootunit-combined'
adminState='trigger' image='backup' resetOnActivate='{0}' />u cimc.set_config_modify( t Truet formatt __proxy__R
( t resett dnt rt inconfigt ret( ( s5 /usr/lib/python2.7/site-packages/salt/modules/cimc.pyt activate_backup_image7 s c C@ s� | s t j j d � � n | s6 t j j d � � n | sQ t j j d � � n | sl t j j d � � n d j | � } d j | | | | � } t d | | t � } | S( u�
Create a CIMC user with username and password.
Args:
uid(int): The user ID slot to create the user account in.
username(str): The name of the user.
password(str): The clear text password of the user.
priv(str): The privilege level of the user.
CLI Example:
.. code-block:: bash
salt '*' cimc.create_user 11 username=admin password=foobar priv=admin
u The user ID must be specified.u The username must be specified.u The password must be specified.u& The privilege level must be specified.u sys/user-ext/user-{0}uj <aaaUser id="{0}" accountStatus="active" name="{1}" priv="{2}"
pwd="{3}" dn="sys/user-ext/user-{0}"/>u cimc.set_config_modify( R t
exceptionst CommandExecutionErrorR
R R
( t uidt usernamet passwordt privR R R ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/cimc.pyt create_userV s c C@ s t d d t � } | S( u�
Get the default values of BIOS tokens.
CLI Example:
.. code-block:: bash
salt '*' cimc.get_bios_defaults
u cimc.get_config_resolver_classu biosPlatformDefaults( R R ( R ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/cimc.pyt get_bios_defaults� s c C@ s t d d t � } | S( u�
Get the C240 server BIOS token values.
CLI Example:
.. code-block:: bash
salt '*' cimc.get_bios_settings
u cimc.get_config_resolver_classu biosSettings( R R ( R ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/cimc.pyt get_bios_settings� s c C@ s t d d t � } | S( u�
Retrieves the configured boot order table.
CLI Example:
.. code-block:: bash
salt '*' cimc.get_boot_order
u cimc.get_config_resolver_classu lsbootDef( R R ( R ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/cimc.pyt get_boot_order� s c C@ s t d d t � } | S( u}
Get the CPU product ID details.
CLI Example:
.. code-block:: bash
salt '*' cimc.get_cpu_details
u cimc.get_config_resolver_classu
pidCatalogCpu( R R ( R ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/cimc.pyt get_cpu_details� s c C@ s t d d t � } | S( uw
Get the HDD product ID details.
CLI Example:
.. code-block:: bash
salt '*' cimc.get_disks
u cimc.get_config_resolver_classu
pidCatalogHdd( R R ( R ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/cimc.pyt get_disks� s c C@ s t d d t � } | S( u�
Get the adapter Ethernet interface details.
CLI Example:
.. code-block:: bash
salt '*' cimc.get_ethernet_interfaces
u cimc.get_config_resolver_classu adaptorHostEthIf( R R ( R ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/cimc.pyt get_ethernet_interfaces� s c C@ s t d d t � } | S( u�
Get the adapter fibre channel interface details.
CLI Example:
.. code-block:: bash
salt '*' cimc.get_fibre_channel_interfaces
u cimc.get_config_resolver_classu adaptorHostFcIf( R R ( R ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/cimc.pyt get_fibre_channel_interfaces� s c C@ s t d d t � } | S( u�
Retrieves the current running firmware versions of server components.
CLI Example:
.. code-block:: bash
salt '*' cimc.get_firmware
u cimc.get_config_resolver_classu firmwareRunning( R R
( R ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/cimc.pyt get_firmware� s c C@ sF t d d t � } y | d d d d SWn t k
rA } d SXd S( u�
Retrieves the hostname from the device.
.. versionadded:: 2019.2.0
CLI Example:
.. code-block:: bash
salt '*' cimc.get_hostname
u cimc.get_config_resolver_classu mgmtIfu
outConfigsi u hostnameu Unable to retrieve hostnameN( R R t Exception( R t err( ( s5 /usr/lib/python2.7/site-packages/salt/modules/cimc.pyt get_hostname s
c C@ s t d d t � } | S( uu
Retrieves LDAP server details.
CLI Example:
.. code-block:: bash
salt '*' cimc.get_ldap
u cimc.get_config_resolver_classu aaaLdap( R R ( R ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/cimc.pyt get_ldap s c C@ s t d d t � } | S( u�
Retrieve the management interface details.
CLI Example:
.. code-block:: bash
salt '*' cimc.get_management_interface
u cimc.get_config_resolver_classu mgmtIf( R R
( R ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/cimc.pyt get_management_interface) s c C@ s t d d t � } | S( u}
Get the memory RAS BIOS token.
CLI Example:
.. code-block:: bash
salt '*' cimc.get_memory_token
u cimc.get_config_resolver_classu" biosVfSelectMemoryRASConfiguration( R R
( R ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/cimc.pyt get_memory_token9 s c C@ s t d d t � } | S( u�
Get the IMM/Memory unit product ID details.
CLI Example:
.. code-block:: bash
salt '*' cimc.get_memory_unit
u cimc.get_config_resolver_classu pidCatalogDimm( R R ( R ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/cimc.pyt get_memory_unitI s c C@ s t d d t � } | S( u�
Get the list of network adapaters and configuration details.
CLI Example:
.. code-block:: bash
salt '*' cimc.get_network_adapters
u cimc.get_config_resolver_classu networkAdapterEthIf( R R ( R ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/cimc.pyt get_network_adaptersY s c C@ s t d d t � } | S( u�
Retrieves the current running NTP configuration.
CLI Example:
.. code-block:: bash
salt '*' cimc.get_ntp
u cimc.get_config_resolver_classu commNtpProvider( R R
( R ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/cimc.pyt get_ntpi s c C@ s t d d t � } | S( u
Get the PCI adapter product ID details.
CLI Example:
.. code-block:: bash
salt '*' cimc.get_disks
u cimc.get_config_resolver_classu pidCatalogPCIAdapter( R R ( R ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/cimc.pyt get_pci_adaptersy s c C@ s t d d t � } | S( u�
Get the configuration of the power settings from the device. This is only available
on some C-Series servers.
.. versionadded:: 2019.2.0
CLI Example:
.. code-block:: bash
salt '*' cimc.get_power_configuration
u cimc.get_config_resolver_classu biosVfResumeOnACPowerLoss( R R ( R ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/cimc.pyt get_power_configuration� s c C@ s t d d t � } | S( u�
Retrieves the power supply unit details.
CLI Example:
.. code-block:: bash
salt '*' cimc.get_power_supplies
u cimc.get_config_resolver_classu equipmentPsu( R R
( R ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/cimc.pyt get_power_supplies� s c C@ s t d d t � } | S( u�
Get the snmp configuration details.
CLI Example:
.. code-block:: bash
salt '*' cimc.get_snmp_config
u cimc.get_config_resolver_classu commSnmp( R R
( R ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/cimc.pyt get_snmp_config� s c C@ s t d d t � } | S( u~
Get the Syslog client-server details.
CLI Example:
.. code-block:: bash
salt '*' cimc.get_syslog
u cimc.get_config_resolver_classu commSyslogClient( R R
( R ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/cimc.pyt
get_syslog� s c C@ s t d d t � } | S( u�
Get the Syslog configuration settings from the system.
.. versionadded:: 2019.2.0
CLI Example:
.. code-block:: bash
salt '*' cimc.get_syslog_settings
u cimc.get_config_resolver_classu
commSyslog( R R
( R ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/cimc.pyt get_syslog_settings� s
c C@ s t d d t � } | S( uy
Get the system information.
CLI Example:
.. code-block:: bash
salt '*' cimc.get_system_info
u cimc.get_config_resolver_classu computeRackUnit( R R
( R ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/cimc.pyt get_system_info� s c C@ s t d d t � } | S( uk
Get the CIMC users.
CLI Example:
.. code-block:: bash
salt '*' cimc.get_users
u cimc.get_config_resolver_classu aaaUser( R R
( R ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/cimc.pyt get_users� s c C@ s t d d t � } | S( u�
Get the VIC adapter general profile details.
CLI Example:
.. code-block:: bash
salt '*' cimc.get_vic_adapters
u cimc.get_config_resolver_classu adaptorGenProfile( R R ( R ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/cimc.pyt get_vic_adapters� s c C@ s t d d t � } | S( u�
Get the VIC adapter uplink port details.
CLI Example:
.. code-block:: bash
salt '*' cimc.get_vic_uplinks
u cimc.get_config_resolver_classu adaptorExtEthIf( R R ( R ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/cimc.pyt get_vic_uplinks s u nfsc
C@ s� | s t j j d � � n | s6 t j j d � � n | sQ t j j d � � n | rr | rr d j | | � } n d } d j | � } d j | | | | | � } t d | | t � } | S( ur
Mounts a remote file through a remote share. Currently, this feature is supported in version 1.5 or greater.
The remote share can be either NFS, CIFS, or WWW.
Some of the advantages of CIMC Mounted vMedia include:
Communication between mounted media and target stays local (inside datacenter)
Media mounts can be scripted/automated
No vKVM requirements for media connection
Multiple share types supported
Connections supported through all CIMC interfaces
Note: CIMC Mounted vMedia is enabled through BIOS configuration.
Args:
name(str): The name of the volume on the CIMC device.
remote_share(str): The file share link that will be used to mount the share. This can be NFS, CIFS, or WWW. This
must be the directory path and not the full path to the remote file.
remote_file(str): The name of the remote file to mount. It must reside within remote_share.
mount_type(str): The type of share to mount. Valid options are nfs, cifs, and www.
username(str): An optional requirement to pass credentials to the remote share. If not provided, an
unauthenticated connection attempt will be made.
password(str): An optional requirement to pass a password to the remote share. If not provided, an
unauthenticated connection attempt will be made.
CLI Example:
.. code-block:: bash
salt '*' cimc.mount_share name=WIN7 remote_share=10.xxx.27.xxx:/nfs remote_file=sl1huu.iso
salt '*' cimc.mount_share name=WIN7 remote_share=10.xxx.27.xxx:/nfs remote_file=sl1huu.iso username=bob password=badpassword
u! The share name must be specified.u( The remote share path must be specified.u' The remote file name must be specified.u) mountOptions='username={0},password={1}'u u sys/svc-ext/vmedia-svc/vmmap-{0}u� <commVMediaMap dn='sys/svc-ext/vmedia-svc/vmmap-{0}' map='{1}'{2}
remoteFile='{3}' remoteShare='{4}' status='created'
volumeName='Win12' />u cimc.set_config_modify( R R R R
R R
(
t namet remote_sharet remote_filet
mount_typeR R t
mount_optionsR R R ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/cimc.pyt mount_share s - c C@ s& d } d } t d | | t � } | S( un
Power cycling the server.
CLI Example:
.. code-block:: bash
salt '*' cimc.reboot
u sys/rack-unit-1uU <computeRackUnit adminPower="cycle-immediate" dn="sys/rack-unit-1"></computeRackUnit>u cimc.set_config_modify( R R
( R R R ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/cimc.pyt rebootc s c C@ s� | s t j j d � � n d } d j | � } t d | | t � } y( | d d d d d k ri t St SWn t k
r� } t SXd
S( u�
Sets the hostname on the server.
.. versionadded:: 2019.2.0
Args:
hostname(str): The new hostname to set.
CLI Example:
.. code-block:: bash
salt '*' cimc.set_hostname foobar
u! Hostname option must be provided.u sys/rack-unit-1/mgmt/if-1u@ <mgmtIf dn="sys/rack-unit-1/mgmt/if-1" hostname="{0}" ></mgmtIf>u cimc.set_config_modifyu outConfigu mgmtIfi u statusu modifiedN( R R R R
R R
R R$ ( t hostnameR R R R% ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/cimc.pyt set_hostnamex s c C@ s� d d d d d d d d g } d } | ra | | k rL | d
j | � 7} qa t j j d � � n | r� | | k r� | d j | � 7} q� t j j d
� � n d } d j | � } t d | | t � } | S( u�
Sets the logging levels of the CIMC devices. The logging levels must match
the following options: emergency, alert, critical, error, warning, notice,
informational, debug.
.. versionadded:: 2019.2.0
Args:
remote(str): The logging level for SYSLOG logs.
local(str): The logging level for the local device.
CLI Example:
.. code-block:: bash
salt '*' cimc.set_logging_levels remote=error local=notice
u emergencyu alertu criticalu erroru warningu noticeu
informationalu debugu u remoteSeverity="{0}"u$ Remote Severity option is not valid.u localSeverity="{0}"u# Local Severity option is not valid.u sys/svc-ext/syslogu5 <commSyslog dn="sys/svc-ext/syslog"{0} ></commSyslog>u cimc.set_config_modify( R
R R R R R
( t remotet localt logging_optionst queryR R R ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/cimc.pyt set_logging_levels� s* u c C@ s8 d } d j | | | | � } t d | | t � } | S( u"
Sets the NTP servers configuration. This will also enable the client NTP service.
Args:
server1(str): The first IP address or FQDN of the NTP servers.
server2(str): The second IP address or FQDN of the NTP servers.
server3(str): The third IP address or FQDN of the NTP servers.
server4(str): The fourth IP address or FQDN of the NTP servers.
CLI Example:
.. code-block:: bash
salt '*' cimc.set_ntp_server 10.10.10.1
salt '*' cimc.set_ntp_server 10.10.10.1 foo.bar.com
u sys/svc-ext/ntp-svcu� <commNtpProvider dn="sys/svc-ext/ntp-svc" ntpEnable="yes" ntpServer1="{0}" ntpServer2="{1}"
ntpServer3="{2}" ntpServer4="{3}"/>u cimc.set_config_modify( R
R R
( t server1t server2t server3t server4R R R ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/cimc.pyt set_ntp_server� s c C@ s� d } | d k r� d } | r� | d k rS | d 7} | r~ | d j | � 7} q~ q� | d k rl | d 7} q� t j j d � � q� n< | d
k r� d } n' | d k r� d } n t j j d
� � d } d j | � } t d | | t � } | S( u�
Sets the power configuration on the device. This is only available for some
C-Series servers.
.. versionadded:: 2019.2.0
Args:
policy(str): The action to be taken when chassis power is restored after
an unexpected power loss. This can be one of the following:
reset: The server is allowed to boot up normally when power is
restored. The server can restart immediately or, optionally, after a
fixed or random delay.
stay-off: The server remains off until it is manually restarted.
last-state: The server restarts and the system attempts to restore
any processes that were running before power was lost.
delayType(str): If the selected policy is reset, the restart can be
delayed with this option. This can be one of the following:
fixed: The server restarts after a fixed delay.
random: The server restarts after a random delay.
delayValue(int): If a fixed delay is selected, once chassis power is
restored and the Cisco IMC has finished rebooting, the system waits for
the specified number of seconds before restarting the server. Enter an
integer between 0 and 240.
CLI Example:
.. code-block:: bash
salt '*' cimc.set_power_configuration stay-off
salt '*' cimc.set_power_configuration reset fixed 0
u u resetu vpResumeOnACPowerLoss="reset"u fixedu delayType="fixed"u delay="{0}"u randomu delayType="random"u Invalid delay type entered.u stay-offu
last-stateu# vpResumeOnACPowerLoss="last-state"u" The power state must be specified.u- sys/rack-unit-1/board/Resume-on-AC-power-lossuv <biosVfResumeOnACPowerLoss
dn="sys/rack-unit-1/board/Resume-on-AC-power-loss"{0}>
</biosVfResumeOnACPowerLoss>u cimc.set_config_modify( R
R R R R R
( t policyt delayTypet
delayValueRC R R R ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/cimc.pyt set_power_configuration� s( *
u primaryc C@ s� | s t j j d � � n | d k r? d } d j | � } n6 | d k rc d } d j | � } n t j j d � � t d | | t � } | S(
u�
Set the SYSLOG server on the host.
Args:
server(str): The hostname or IP address of the SYSLOG server.
type(str): Specifies the type of SYSLOG server. This can either be primary (default) or secondary.
CLI Example:
.. code-block:: bash
salt '*' cimc.set_syslog_server foo.bar.com
salt '*' cimc.set_syslog_server foo.bar.com primary
salt '*' cimc.set_syslog_server foo.bar.com secondary
u$ The SYSLOG server must be specified.u primaryu! sys/svc-ext/syslog/client-primaryu� <commSyslogClient name='primary' adminState='enabled' hostname='{0}'
dn='sys/svc-ext/syslog/client-primary'> </commSyslogClient>u secondaryu# sys/svc-ext/syslog/client-secondaryu� <commSyslogClient name='secondary' adminState='enabled' hostname='{0}'
dn='sys/svc-ext/syslog/client-secondary'> </commSyslogClient>u4 The SYSLOG type must be either primary or secondary.u cimc.set_config_modify( R R R R
R R
( t servert typeR R R ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/cimc.pyt set_syslog_server4 s c C@ s� d } | s! t j j d � � n | r= | d j | � 7} n | rY | d j | � 7} n | ru | d j | � 7} n | r� | d j | � 7} n d j | � } d j | | � } t d | | t � } | S(
u�
Sets a CIMC user with specified configurations.
.. versionadded:: 2019.2.0
Args:
uid(int): The user ID slot to create the user account in.
username(str): The name of the user.
password(str): The clear text password of the user.
priv(str): The privilege level of the user.
status(str): The account status of the user.
CLI Example:
.. code-block:: bash
salt '*' cimc.set_user 11 username=admin password=foobar priv=admin active
u u The user ID must be specified.u accountStatus="{0}"u name="{0}"u priv="{0}"u
pwd="{0}"u sys/user-ext/user-{0}u1 <aaaUser id="{0}"{1} dn="sys/user-ext/user-{0}"/>u cimc.set_config_modify( R R R R
R R
( R R R R t statust confR R R ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/cimc.pyt set_user\ s c C@ sh | s t j j d � � n | s6 t j j d � � n d } d j | | � } t d | | t � } | S( u.
Update the BIOS firmware through TFTP.
Args:
server(str): The IP address or hostname of the TFTP server.
path(str): The TFTP path and filename for the BIOS image.
CLI Example:
.. code-block:: bash
salt '*' cimc.tftp_update_bios foo.bar.com HP-SL2.cap
u" The server name must be specified.u The TFTP path must be specified.u! sys/rack-unit-1/bios/fw-updatableu� <firmwareUpdatable adminState='trigger' dn='sys/rack-unit-1/bios/fw-updatable'
protocol='tftp' remoteServer='{0}' remotePath='{1}'
type='blade-bios' />u cimc.set_config_modify( R R R R
R R
( RN t pathR R R ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/cimc.pyt tftp_update_bios� s c C@ sh | s t j j d � � n | s6 t j j d � � n d } d j | | � } t d | | t � } | S( u.
Update the CIMC firmware through TFTP.
Args:
server(str): The IP address or hostname of the TFTP server.
path(str): The TFTP path and filename for the CIMC image.
CLI Example:
.. code-block:: bash
salt '*' cimc.tftp_update_cimc foo.bar.com HP-SL2.bin
u" The server name must be specified.u The TFTP path must be specified.u! sys/rack-unit-1/mgmt/fw-updatableu� <firmwareUpdatable adminState='trigger' dn='sys/rack-unit-1/mgmt/fw-updatable'
protocol='tftp' remoteServer='{0}' remotePath='{1}'
type='blade-controller' />u cimc.set_config_modify( R R R R
R R
( RN RT R R R ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/cimc.pyt tftp_update_cimc� s (5 t __doc__t
__future__R R R t loggingt salt.utils.platformR t salt.proxy.cimct getLoggert __name__t logR R R
R t NoneR R R R R R R! R" R# R& R' R( R) R* R+ R, R- R. R/ R0 R1 R2 R3 R4 R5 R6 R< R= R? RD RI RM RP RS RU RV ( ( ( s5 /usr/lib/python2.7/site-packages/salt/modules/cimc.pyt <module> sb . @ !4 G(3"
Mini Shell