openbmc-tools/openbmctool/README.md

12 - `-H`: The hostname or IP for the BMC
13 - `-U`: The username One of the password options:
14 - `-P`: The password, provided in-line
15 - `-A`: Prompt for a password
16 - `-E`: Take the password from envvar `OPENBMCTOOL_PASSWORD`
18 ## Enabling and Disabling Local BMC User Accounts
20 The local user accounts on the BMC, such as root, can be disabled, queried, and
21 re-enabled with the `local_users` sub-command.
23 Important: After disabling local users, an LDAP user will need to be used for
27 To view current local user account status:
33 To disable all local user accounts:
39 To re-enable all local user accounts:
54 - <https://www.rsyslog.com/storing-and-forwarding-remote-messages/>
55 - <https://www.rsyslog.com/doc/rsyslog%255Fconf%255Ffilter.html>
56 - <https://www.thegeekdiary.com/understanding-rsyslog-filter-options/>
61 openbmctool <connection options> logging remote_logging_config -a <IP address> -p <port>
78 an existing remote server to a new one (i.e before re-running the
90 ## BMC Certificate management
92 Certificate management allows replacing the existing certificate and private key
94 private key file. Certificate management allows the user to install server,
100 openbmctool <connection options> certificate update server https -f <File>
103 File: The [PEM](https://en.wikipedia.org/wiki/Privacy-Enhanced_Mail) file
109 openbmctool <connection options> certificate update client ldap -f <File>
117 openbmctool <connection options> certificate update authority ldap -f <File>
128 Deleting a certificate will create a new self-signed certificate and will
149 user-management functionality.
151 BMC supports secure/non-secure LDAP configuration.
158 …dap enable --uri="ldap://<ldap server IP/hostname>" --bindDN=<bindDN> --baseDN=<basDN> --bindPassw…
170 …ap enable --uri="ldaps://<ldap server IP/hostname>" --bindDN=<bindDN> --baseDN=<basDN> --bindPassw…
186 a single property user need to recreate the LDAP config with the changed values.
194 NOTE: Make sure that root user is enabled before running the above command
197 To enable root user, refer to the "To re-enable all local user accounts" section
200 Currently openbmctool doesn't have support for specific user enablement.
205 …l.py <connection options> ldap privilege-mapper create --groupName=<groupName> --privilege="priv-a…
211 openbmctool.py <connection options> ldap privilege-mapper delete --groupName=<groupName>
217 openbmctool.py <connection options> ldap privilege-mapper list
222 - Configure the DNS server.
223 - Configure LDAP. a) Configure CA certificate if secure LDAP server is being
224   configured. b) Create LDAP Configuration with local user.
225 - Configure user privilege.
229 a) If a user tries to login with LDAP credentials and has not added the
230 privilege mapping for the LDAP credentials then the user will get the following
237 b) The following message may mean that the user lacks the required privileges on
241 privilege=priv-admin