File manager - Edit - /opt/saltstack/salt/lib/python3.10/site-packages/salt/modules/__pycache__/ipmi.cpython-310.pyc
Back
o ;j�e � @ s| d Z dZzddlmZ ddlmZ W n ey( Z z ee�ZW Y dZ[ndZ[ww dZ dd� Z dd � Z G d d � d �Z G d d � d �Z dEdd�Zdd� Z dFdd�ZdGdd �ZdHd d �Z dId d �ZdHd!d"�Zd#d$� ZdJd%d&�ZdKd(d)�Zd*d+� Zd,d-� Zd.d/� Zd0d1� ZdLd3d4�Z dMd6d7�Z dNd9d:�Z dHd;d<�Z dHd=d>�Z dHd?d@�Z! dOdAdB�Z"dHdCdD�Z#dS )Pa& Support IPMI commands over LAN. This module does not talk to the local systems hardware through IPMI drivers. It uses a python module `pyghmi`. :depends: Python module pyghmi. You can install pyghmi using pip: .. code-block:: bash pip install pyghmi :configuration: The following configuration defaults can be define (pillar or config files): .. code-block:: python ipmi.config: api_host: 127.0.0.1 api_user: admin api_pass: apassword api_port: 623 api_kg: None Usage can override the config defaults: .. code-block:: bash salt-call ipmi.get_user api_host=myipmienabled.system api_user=admin api_pass=pass uid=1 N� )�command)�sessionZipmic C s t d u t fS �N)� IMPORT_ERR� r r �E/opt/saltstack/salt/lib/python3.10/site-packages/salt/modules/ipmi.py� __virtual__+ s r c K s` ddddddd�}dt � v r t� d �}|�td |i �� t|�t| �@ D ]}| | ||< q%|S ) z Return configuration Z localhostio Zadmin� N� )�api_host�api_port�api_user�api_pass�api_kg�api_login_timeout�__salt__z.configz config.get)�globals�__virtualname__�updater �set)�kwargs�configZ config_key�kr r r � _get_config/ s � r c @ s( e Zd ZdZdd� Zdd� Zdd� ZdS )� _IpmiCommandNc K s< t di |��}tj|d |d |d |d |d d�| _d S )Nr r r r r )�bmc�userid�password�port�kgr )r r ZCommand�o��selfr r r r r �__init__F s �z_IpmiCommand.__init__c C � | j S r �r �r" r r r � __enter__P � z_IpmiCommand.__enter__c C s | j r | j j�� d S d S r )r Z ipmi_session�logout�r" �type�value� tracebackr r r �__exit__S s �z_IpmiCommand.__exit__)�__name__� __module__� __qualname__r r# r' r. r r r r r C s r c @ s0 e Zd ZdZdd� Zdd� Zdd� Zdd � ZdS ) � _IpmiSessionNc C s d|v r t |d ��d S )N�error)� Exception)r" �responser r r �_onlogon[ s �z_IpmiSession._onlogonc K sr t d i |��}tj|d |d |d |d |d | jd�| _| jjs3|d | j_| jjdd � | jjr"d | j_d S ) Nr r r r r )r r r r r Zonlogonr � )�timeout� r )r r ZSessionr6 r ZloggedZ maxtimeoutZ wait_for_rspr! r r r r# _ s � � z_IpmiSession.__init__c C r$ r r% r& r r r r' o r( z_IpmiSession.__enter__c C s | j r | j �� d S d S r )r r) r* r r r r. r s �z_IpmiSession.__exit__)r/ r0 r1 r r6 r# r' r. r r r r r2 X s r2 r Tc K sT t di |���}|jt| �t|�||||d�}|W d � S 1 s#w Y dS )a Send raw ipmi command This allows arbitrary IPMI bytes to be issued. This is commonly used for certain vendor specific commands. :param netfn: Net function number :param command: Command value :param bridge_request: The target slave address and channel number for the bridge request. :param data: Command data as a tuple or list :param kwargs: - api_host=127.0.0.1 - api_user=admin - api_pass=example - api_port=623 - api_kg=None :returns: dict -- The response from IPMI device CLI Examples: .. code-block:: bash salt-call ipmi.raw_command netfn=0x06 command=0x46 data=[0x02] # this will return the name of the user with id 2 in bytes )�netfnr �bridge_request�data�retry� delay_xmitNr )r2 � raw_command�int) r: r r; r< r= r> r �s�rr r r r? w s �$�r? c K sr z%d| vr d| d< t di | ��� } W d � W dS 1 s w Y W dS ty8 } zW Y d}~dS d}~ww )aV Returns True if connection success. This uses an aggressive timeout value! :param kwargs: - api_host=127.0.0.1 - api_user=admin - api_pass=example - api_port=623 - api_kg=None CLI Examples: .. code-block:: bash salt-call ipmi.fast_connect_test api_host=172.168.0.9 r r NTFr )r2 r4 )r rA �er r r �fast_connect_test� s $����rD � � non_volatileF�always� administratorc K �J t di |���} | �| |||||||�W d � S 1 s w Y dS )a� Set channel access :param channel: number [1:7] :param access_update_mode: - 'dont_change' = don't set or change Channel Access - 'non_volatile' = set non-volatile Channel Access - 'volatile' = set volatile (active) setting of Channel Access :param alerting: PEF Alerting Enable/Disable - True = enable PEF Alerting - False = disable PEF Alerting on this channel (Alert Immediate command can still be used to generate alerts) :param per_msg_auth: Per-message Authentication - True = enable - False = disable Per-message Authentication. [Authentication required to activate any session on this channel, but authentication not used on subsequent packets for the session.] :param user_level_auth: User Level Authentication Enable/Disable - True = enable User Level Authentication. All User Level commands are to be authenticated per the Authentication Type that was negotiated when the session was activated. - False = disable User Level Authentication. Allow User Level commands to be executed without being authenticated. If the option to disable User Level Command authentication is accepted, the BMC will accept packets with Authentication Type set to None if they contain user level commands. For outgoing packets, the BMC returns responses with the same Authentication Type that was used for the request. :param access_mode: Access Mode for IPMI messaging (PEF Alerting is enabled/disabled separately from IPMI messaging) - disabled = disabled for IPMI messaging - pre_boot = pre-boot only channel only available when system is in a powered down state or in BIOS prior to start of boot. - always = channel always available regardless of system mode. BIOS typically dedicates the serial connection to the BMC. - shared = same as always available, but BIOS typically leaves the serial port available for software use. :param privilege_update_mode: Channel Privilege Level Limit. This value sets the maximum privilege level that can be accepted on the specified channel. - dont_change = don't set or change channel Privilege Level Limit - non_volatile = non-volatile Privilege Level Limit according - volatile = volatile setting of Privilege Level Limit :param privilege_level: Channel Privilege Level Limit - reserved = unused - callback - user - operator - administrator - proprietary = used by OEM :param kwargs: - api_host=127.0.0.1 - api_user=admin - api_pass=example - api_port=623 - api_kg=None CLI Examples: .. code-block:: bash salt-call ipmi.set_channel_access privilege_level='administrator' Nr )r �set_channel_access) �channelZaccess_update_modeZalertingZ per_msg_authZuser_level_authZ access_modeZprivilege_update_mode�privilege_levelr rA r r r rJ � s ]�$�rJ c K s< t di |��� }|�| �W d � S 1 sw Y dS )a� :param kwargs:api_host='127.0.0.1' api_user='admin' api_pass='example' api_port=623 :param channel: number [1:7] :param read_mode: - non_volatile = get non-volatile Channel Access - volatile = get present volatile (active) setting of Channel Access :param kwargs: - api_host=127.0.0.1 - api_user=admin - api_pass=example - api_port=623 - api_kg=None Return Data A Python dict with the following keys/values: .. code-block:: python { alerting: per_msg_auth: user_level_auth: access_mode:{ (ONE OF) 0: 'disabled', 1: 'pre_boot', 2: 'always', 3: 'shared' } privilege_level: { (ONE OF) 1: 'callback', 2: 'user', 3: 'operator', 4: 'administrator', 5: 'proprietary', } } CLI Examples: .. code-block:: bash salt-call ipmi.get_channel_access channel=1 Nr )r �get_channel_access)rK Z read_moder rA r r r rM ) s 0$�rM c K �< t di |��� }|�| �W d � S 1 sw Y dS )a Get channel info :param channel: number [1:7] :param kwargs: - api_host=127.0.0.1 - api_user=admin - api_pass=example - api_port=623 - api_kg=None Return Data channel session supports .. code-block:: none - no_session: channel is session-less - single: channel is single-session - multi: channel is multi-session - auto: channel is session-based (channel could alternate between single- and multi-session operation, as can occur with a serial/modem channel that supports connection mode auto-detect) CLI Examples: .. code-block:: bash salt-call ipmi.get_channel_info Nr )r �get_channel_info)rK r rA r r r rO ] � $�rO c K sF t di |���}|�| |||||�W d � S 1 s w Y dS )a# Set user access :param uid: user number [1:16] :param channel: number [1:7] :param callback: User Restricted to Callback - False = User Privilege Limit is determined by the User Privilege Limit parameter, below, for both callback and non-callback connections. - True = User Privilege Limit is determined by the User Privilege Limit parameter for callback connections, but is restricted to Callback level for non-callback connections. Thus, a user can only initiate a Callback when they 'call in' to the BMC, but once the callback connection has been made, the user could potentially establish a session as an Operator. :param link_auth: User Link authentication enable/disable (used to enable whether this user's name and password information will be used for link authentication, e.g. PPP CHAP) for the given channel. Link authentication itself is a global setting for the channel and is enabled/disabled via the serial/modem configuration parameters. :param ipmi_msg: User IPMI Messaging: (used to enable/disable whether this user's name and password information will be used for IPMI Messaging. In this case, 'IPMI Messaging' refers to the ability to execute generic IPMI commands that are not associated with a particular payload type. For example, if IPMI Messaging is disabled for a user, but that user is enabled for activating the SOL payload type, then IPMI commands associated with SOL and session management, such as Get SOL Configuration Parameters and Close Session are available, but generic IPMI commands such as Get SEL Time are unavailable.) :param privilege_level: User Privilege Limit. (Determines the maximum privilege level that the user is allowed to switch to on the specified channel.) - callback - user - operator - administrator - proprietary - no_access :param kwargs: - api_host=127.0.0.1 - api_user=admin - api_pass=example - api_port=623 - api_kg=None CLI Examples: .. code-block:: bash salt-call ipmi.set_user_access uid=2 privilege_level='operator' Nr )r �set_user_access)�uidrK �callback� link_auth�ipmi_msgrL r rA r r r rQ s E �$�rQ c K �@ t di |���}|j| |d�W d � S 1 sw Y dS )aE Get user access :param uid: user number [1:16] :param channel: number [1:7] :param kwargs: - api_host=127.0.0.1 - api_user=admin - api_pass=example - api_port=623 - api_kg=None Return Data .. code-block:: none channel_info: - max_user_count = maximum number of user IDs on this channel - enabled_users = count of User ID slots presently in use - users_with_fixed_names = count of user IDs with fixed names access: - callback - link_auth - ipmi_msg - privilege_level: [reserved, callback, user, operator administrator, proprietary, no_access] CLI Examples: .. code-block:: bash salt-call ipmi.get_user_access uid=2 )rK Nr )r �get_user_access)rR rK r rA r r r rW � s # $�rW c K �> t di |���}|�| |�W d � S 1 sw Y dS )ae Set user name :param uid: user number [1:16] :param name: username (limit of 16bytes) :param kwargs: - api_host=127.0.0.1 - api_user=admin - api_pass=example - api_port=623 - api_kg=None CLI Examples: .. code-block:: bash salt-call ipmi.set_user_name uid=2 name='steverweber' Nr )r � set_user_name)rR �namer rA r r r rY � � $�rY c K s@ t di |���}|j| dd�W d � S 1 sw Y dS )a[ Get user name :param uid: user number [1:16] :param return_none_on_error: return None on error :param kwargs: - api_host=127.0.0.1 - api_user=admin - api_pass=example - api_port=623 - api_kg=None CLI Examples: .. code-block:: bash salt-call ipmi.get_user_name uid=2 T)�return_none_on_errorNr )r � get_user_name)rR r\ r rA r r r r] s $�r] � set_passwordc K sD t di |���}|j| d|d� W d � dS 1 sw Y dS )a� Set user password and (modes) :param uid: id number of user. see: get_names_uid()['name'] :param mode: - disable = disable user connections - enable = enable user connections - set_password = set or ensure password - test_password = test password is correct :param password: max 16 char string (optional when mode is [disable or enable]) :param kwargs: - api_host=127.0.0.1 - api_user=admin - api_pass=example - api_port=623 - api_kg=None :return: True on success when mode = test_password, return False on bad password CLI Example: .. code-block:: bash salt-call ipmi.set_user_password api_host=127.0.0.1 api_user=admin api_pass=pass uid=1 password=newPass salt-call ipmi.set_user_password uid=1 mode=enable r^ )�moder NTr )r �set_user_password)rR r_ r r rA r r r r` s ��r` c K �: t di | ��� }|�� W d � S 1 sw Y dS )a Get Summarize health This provides a summary of the health of the managed system. It additionally provides an iterable list of reasons for warning, critical, or failed assessments. good health: {'badreadings': [], 'health': 0} :param kwargs: - api_host=127.0.0.1 - api_user=admin - api_pass=example - api_port=623 - api_kg=None CLI Example: .. code-block:: bash salt-call ipmi.get_health api_host=127.0.0.1 api_user=admin api_pass=pass Nr )r � get_health�r rA r r r rb D s $�rb c K s> t di | ���}|�� d W d � S 1 sw Y dS )a� Get current power state The response, if successful, should contain 'powerstate' key and either 'on' or 'off' to indicate current state. :param kwargs: - api_host=127.0.0.1 - api_user=admin - api_pass=example - api_port=623 - api_kg=None CLI Example: .. code-block:: bash salt-call ipmi.get_power api_host=127.0.0.1 api_user=admin api_pass=pass Z powerstateNr )r � get_powerrc r r r rd _ s $�rd c K sn ddl }tdi | ���"}i }|�� D ]}|r$|�t|��}|||�d�< qW d � |S 1 s0w Y |S )aX Get sensor readings Iterates sensor reading objects :param kwargs: - api_host=127.0.0.1 - api_user=admin - api_pass=example - api_port=623 - api_kg=None CLI Example: .. code-block:: bash salt-call ipmi.get_sensor_data api_host=127.0.0.1 api_user=admin api_pass=pass r NrZ r )�astr �get_sensor_dataZ literal_eval�repr�pop)r re rA r< �readingrB r r r rf w s �� ��rf c K ra )a9 Get current boot device override information. Provides the current requested boot device. Be aware that not all IPMI devices support this. Even in BMCs that claim to, occasionally the BIOS or UEFI fail to honor it. This is usually only applicable to the next reboot. :param kwargs: - api_host=127.0.0.1 - api_user=admin - api_pass=example - api_port=623 - api_kg=None CLI Example: .. code-block:: bash salt-call ipmi.get_bootdev api_host=127.0.0.1 api_user=admin api_pass=pass Nr )r � get_bootdevrc r r r rj � s $�rj �power_onc K sh | du s| dkr d} | du s| dkrd} t d i |���}|j| |d�W d � S 1 s-w Y dS ) aj Request power state change :param name: * power_on -- system turn on * power_off -- system turn off (without waiting for OS) * shutdown -- request OS proper shutdown * reset -- reset (without waiting for OS) * boot -- If system is off, then 'on', else 'reset' :param ensure: If (bool True), do not return until system actually completes requested state change for 300 seconds. If a non-zero (int), adjust the wait time to the requested number of seconds :param kwargs: - api_host=127.0.0.1 - api_user=admin - api_pass=example - api_port=623 - api_kg=None :returns: dict -- A dict describing the response retrieved CLI Examples: .. code-block:: bash salt-call ipmi.set_power state=shutdown wait=True Trk �onFZ power_offZoff)�waitNr )r � set_power)�staterm r rA r r r rn � s $�rn �defaultc K s< t di |��� }|�| �W d � S 1 sw Y dS )a� Set boot device to use on next reboot :param bootdev: - network: Request network boot - hd: Boot from hard drive - safe: Boot from hard drive, requesting 'safe mode' - optical: boot from CD/DVD/BD drive - setup: Boot into setup utility - default: remove any IPMI directed boot device request :param persist: If true, ask that system firmware use this device beyond next boot. Be aware many systems do not honor this :param uefiboot: If true, request UEFI boot explicitly. Strictly speaking, the spec suggests that if not set, the system should BIOS boot and offers no "don't care" option. In practice, this flag not being set does not preclude UEFI boot on any system I've encountered. :param kwargs: - api_host=127.0.0.1 - api_user=admin - api_pass=example - api_port=623 - api_kg=None :returns: dict or True -- If callback is not provided, the response CLI Examples: .. code-block:: bash salt-call ipmi.set_bootdev bootdev=network persist=True Nr )r � set_bootdev)ZbootdevZpersistZuefibootr rA r r r rq � s &$�rq �X c K rV )a2 Request identify light Request the identify light to turn off, on for a duration, or on indefinitely. Other than error exceptions, :param on: Set to True to force on or False to force off :param duration: Set if wanting to request turn on for a duration in seconds, None = indefinitely. :param kwargs: - api_host=127.0.0.1 - api_user=admin - api_pass=example - api_port=623 - api_kg=None CLI Examples: .. code-block:: bash salt-call ipmi.set_identify )rl �durationNr )r � set_identify)rl rs r rA r r r rt � s $�rt c K s t d| dd�|��}|d d S )aR Get max users in channel :param channel: number [1:7] :param kwargs: - api_host=127.0.0.1 - api_user=admin - api_pass=example - api_port=623 - api_kg=None :return: int -- often 16 CLI Examples: .. code-block:: bash salt-call ipmi.get_channel_max_user_count r7 )rK rR Z channel_infoZmax_user_countNr )rW )rK r �accessr r r �get_channel_max_user_count s rv c K s8 t | fi |��}t| |fi |��}|| ||d d�}|S )a� Get user from uid and access on channel :param uid: user number [1:16] :param channel: number [1:7] :param kwargs: - api_host=127.0.0.1 - api_user=admin - api_pass=example - api_port=623 - api_kg=None Return Data .. code-block:: none name: (str) uid: (int) channel: (int) access: - callback (bool) - link_auth (bool) - ipmi_msg (bool) - privilege_level: (str)[callback, user, operatorm administrator, proprietary, no_access] CLI Examples: .. code-block:: bash salt-call ipmi.get_user uid=2 ru )rZ rR rK ru )r] rW )rR rK r rZ ru r< r r r �get_user1 s !rw c K rN )a} get list of users and access information :param channel: number [1:7] :param kwargs: - api_host=127.0.0.1 - api_user=admin - api_pass=example - api_port=623 - api_kg=None :return: - name: (str) - uid: (int) - channel: (int) - access: - callback (bool) - link_auth (bool) - ipmi_msg (bool) - privilege_level: (str)[callback, user, operatorm administrator, proprietary, no_access] CLI Examples: .. code-block:: bash salt-call ipmi.get_users api_host=172.168.0.7 Nr )r � get_users)rK r �cr r r rx X rP rx c K rI )a� create/ensure a user is created with provided settings. :param privilege_level: User Privilege Limit. (Determines the maximum privilege level that the user is allowed to switch to on the specified channel.) * callback * user * operator * administrator * proprietary * no_access :param kwargs: - api_host=127.0.0.1 - api_user=admin - api_pass=example - api_port=623 - api_kg=None CLI Examples: .. code-block:: bash salt-call ipmi.create_user uid=2 name=steverweber api_host=172.168.0.7 api_pass=nevertell Nr )r � create_user) rR rZ r rK rS rT rU rL r ry r r r rz z s $�$�rz c K rX )aK Delete user (helper) :param uid: user number [1:16] :param channel: number [1:7] :param kwargs: - api_host=127.0.0.1 - api_user=admin - api_pass=example - api_port=623 - api_kg=None CLI Examples: .. code-block:: bash salt-call ipmi.user_delete uid=2 Nr )r � user_delete)rR rK r ry r r r r{ � r[ r{ )Nr TN)rE rF FFFrG rF rH )rE rF )rE )rE TTTrH )T)r^ N)rk T)rp FF)Trr )rE FTTrH )$�__doc__r Z pyghmi.ipmir Zpyghmi.ipmi.privater r4 �ex�strr r r r r2 r? rD rJ rM rO rQ rW rY r] r` rb rd rf rj rn rq rt rv rw rx rz r{ r r r r �<module> sn �� �* � j 4$ � K' % & * '& �*
| ver. 1.4 |
Github
|
.
| PHP 8.2.30 | Generation time: 0 |
proxy
|
phpinfo
|
Settings