mirror of
https://github.com/saltstack/salt.git
synced 2025-04-17 10:10:20 +00:00
Fix documentation markup for salt.modules.ipmi
This commit is contained in:
parent
276eb3a843
commit
d2614d6169
1 changed files with 53 additions and 42 deletions
|
@ -200,46 +200,56 @@ def set_channel_access(channel=14, access_update_mode='non_volatile',
|
|||
- '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)
|
||||
(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.]
|
||||
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.
|
||||
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.
|
||||
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.
|
||||
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.
|
||||
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.
|
||||
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.
|
||||
|
||||
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
|
||||
|
@ -358,37 +368,38 @@ def set_user_access(uid, channel=14, callback=True, link_auth=True, ipmi_msg=Tru
|
|||
:param channel: number [1:7]
|
||||
|
||||
:parm 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.
|
||||
|
||||
- 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.
|
||||
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.)
|
||||
(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.)
|
||||
|
||||
: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
|
||||
|
|
Loading…
Add table
Reference in a new issue