diff --git a/docs/source/guides/admin-guides/references/man1/rspconfig.1.rst b/docs/source/guides/admin-guides/references/man1/rspconfig.1.rst index 538e223ba..395ef33ee 100644 --- a/docs/source/guides/admin-guides/references/man1/rspconfig.1.rst +++ b/docs/source/guides/admin-guides/references/man1/rspconfig.1.rst @@ -73,6 +73,22 @@ OpenBMC specific: \ **rspconfig**\ \ *noderange*\ \ **ntpservers**\ ={\ *ntpservers*\ } +\ **rspconfig**\ \ *noderange*\ \ **alert** + +\ **rspconfig**\ \ *noderange*\ \ **alert**\ ={\ *ip:port*\ |\ **off**\ |\ **disable**\ } + +\ **rspconfig**\ \ *noderange*\ \ **snmpdest** + +\ **rspconfig**\ \ *noderange*\ \ **snmpdest**\ =\ *snmpmanager-IP[:port]*\ [\ **-d | -**\ **-delete**\ ] + +\ **rspconfig**\ \ *noderange*\ \ **userls** + +\ **rspconfig**\ \ *noderange*\ \ **useradd**\ =\ *user*\ \ **password**\ =\ *password*\ \ **privilege**\ ={\ **priv-admin**\ |\ **priv-operator**\ |\ **priv-user**\ |\ **priv-callback**\ } [\ **groups**\ ={\ **ipmi,redfish,ssh,web**\ }] [\ **enabled**\ ={\ **0**\ |\ **1**\ }] + +\ **rspconfig**\ \ *noderange*\ \ **userch**\ =\ *user*\ [\ **password**\ =\ *password*\ ] [\ **privilege**\ ={\ **priv-admin**\ |\ **priv-operator**\ |\ **priv-user**\ |\ **priv-callback**\ }] [\ **groups**\ ={\ **ipmi,redfish,ssh,web**\ }] [\ **enabled**\ ={\ **0**\ |\ **1**\ }] + +\ **rspconfig**\ \ *noderange*\ \ **userrm**\ =\ *user* + \ **rspconfig**\ \ *noderange*\ \ **powerrestorepolicy**\ \ **rspconfig**\ \ *noderange*\ \ **powerrestorepolicy={always_on|restore|always_off}**\ @@ -309,6 +325,11 @@ OPTIONS Turn on or off SNMP alerts. +\ **alert**\ | \ **alert**\ ={\ *ip:port*\ |\ **off**\ |\ **disable**\ } + + For OpenBMC nodes, show or set the remote syslog destination. Specifying \ **off**\ or \ **disable**\ disables remote logging. + + \ **autopower**\ ={\ *enable*\ | \ *disable*\ } @@ -631,6 +652,31 @@ OPTIONS Get or set where the SNMP alerts should be sent to. +\ **snmpdest**\ | \ **snmpdest**\ =\ *snmpmanager-IP[:port]*\ [\ **-d | -**\ **-delete**\ ] + + For OpenBMC nodes, list, add, or remove SNMP trap destinations. If no port is specified, port 162 is used. + + +\ **userls** + + For OpenBMC nodes, list local BMC users and their privilege, enabled state, and groups. + + +\ **useradd**\ =\ *user*\ \ **password**\ =\ *password*\ \ **privilege**\ ={\ **priv-admin**\ |\ **priv-operator**\ |\ **priv-user**\ |\ **priv-callback**\ } [\ **groups**\ ={\ **ipmi,redfish,ssh,web**\ }] [\ **enabled**\ ={\ **0**\ |\ **1**\ }] + + For OpenBMC nodes, create a local BMC user. If \ **groups**\ is omitted, all supported OpenBMC groups are used. If \ **enabled**\ is omitted, the user is enabled. + + +\ **userch**\ =\ *user*\ [\ **password**\ =\ *password*\ ] [\ **privilege**\ ={\ **priv-admin**\ |\ **priv-operator**\ |\ **priv-user**\ |\ **priv-callback**\ }] [\ **groups**\ ={\ **ipmi,redfish,ssh,web**\ }] [\ **enabled**\ ={\ **0**\ |\ **1**\ }] + + For OpenBMC nodes, update the password, privilege, groups, or enabled state for a local BMC user. + + +\ **userrm**\ =\ *user* + + For OpenBMC nodes, delete a local BMC user. + + \ **solcfg**\ ={\ **enable | disable**\ } diff --git a/perl-xCAT/xCAT/Usage.pm b/perl-xCAT/xCAT/Usage.pm index 3b3b60d06..03b221946 100644 --- a/perl-xCAT/xCAT/Usage.pm +++ b/perl-xCAT/xCAT/Usage.pm @@ -184,6 +184,14 @@ my %usage = ( rspconfig gard -c|--clear rspconfig [hostname|ntpservers] rspconfig [hostname=<*|hostname>|ntpservers=] + rspconfig alert + rspconfig alert= + rspconfig snmpdest + rspconfig snmpdest= [-d|--delete] + rspconfig userls + rspconfig useradd= password= privilege= [groups=] [enabled=<0|1>] + rspconfig userch= [password=] [privilege=] [groups=] [enabled=<0|1>] + rspconfig userrm= rspconfig sshcfg rspconfig powerrestorepolicy rspconfig powerrestorepolicy={always_on|restore|always_off} diff --git a/xCAT-client/pods/man1/rspconfig.1.pod b/xCAT-client/pods/man1/rspconfig.1.pod index f452dc2cc..c349e87d2 100644 --- a/xCAT-client/pods/man1/rspconfig.1.pod +++ b/xCAT-client/pods/man1/rspconfig.1.pod @@ -50,6 +50,22 @@ B I B B I B={I} +B I B + +B I B={I|B|B} + +B I B + +B I B=I [B<-d>|B<--delete>] + +B I B + +B I B=I B=I B={B|B|B|B} [B={B}] [B={B<0>|B<1>}] + +B I B=I [B=I] [B={B|B|B|B}] [B={B}] [B={B<0>|B<1>}] + +B I B=I + B I B B I B @@ -258,6 +274,10 @@ For options B|B|B|B|B|B