Command Reference ( web mode )
List of web mode commands.
web ( apikey_add ) : cmdbox -m web -c apikey_add <Option>
Add an ApiKey for a user in Web mode.
Option |
Type |
Multi |
Required |
Default |
Choices |
Description |
|---|---|---|---|---|---|---|
--user_name <user_name> |
str |
required |
Specify the target user name. |
|||
--apikey_name <apikey_name> |
str |
required |
Specify the ApiKey name for this user. |
|||
--signin_file <signin_file> |
file |
required |
.cmdbox/user_list.yml |
Specify a file containing users and passwords with which they can signin.Typically, specify '.cmdbox/user_list.yml'. |
Output Schema
This command implements output_schema() returning Result model.
{
"success": {
"performance": [
{
"key": "string",
"value": null
}
],
"apikey": "string",
"msg": "string"
},
"warn": {},
"error": {},
"schema": {},
"end": false
}
Field |
Type |
Required |
Default |
Description |
|---|---|---|---|---|
success |
Data | null |
no |
null |
成功した場合の結果 |
success.performance |
list[KeyVal] | null |
no |
null |
パフォーマンス情報のリスト |
success.apikey |
str | null |
no |
null |
APIキー |
success.msg |
str | null |
no |
null |
処理結果のメッセージ |
warn |
dict[str, any] | Data | str | bool | null |
no |
null |
警告がある場合の結果 |
warn.performance |
list[KeyVal] | null |
no |
null |
パフォーマンス情報のリスト |
error |
dict[str, any] | Data | str | bool | null |
no |
null |
エラーがある場合の結果 |
error.performance |
list[KeyVal] | null |
no |
null |
パフォーマンス情報のリスト |
schema |
dict[str, any] | null |
no |
null |
スキーマ情報 |
end |
bool | null |
no |
null |
終了フラグ |
web ( apikey_del ) : cmdbox -m web -c apikey_del <Option>
Del an ApiKey for a user in Web mode.
Option |
Type |
Multi |
Required |
Default |
Choices |
Description |
|---|---|---|---|---|---|---|
--user_name <user_name> |
str |
required |
Specify the target user name. |
|||
--apikey_name <apikey_name> |
str |
required |
Specify the ApiKey name for this user. |
|||
--signin_file <signin_file> |
file |
required |
.cmdbox/user_list.yml |
Specify a file containing users and passwords with which they can signin.Typically, specify '.cmdbox/user_list.yml'. |
Output Schema
This command implements output_schema() returning Result model.
{
"success": {
"performance": [
{
"key": "string",
"value": null
}
],
"msg": "string"
},
"warn": {},
"error": {},
"schema": {},
"end": false
}
Field |
Type |
Required |
Default |
Description |
|---|---|---|---|---|
success |
Data | null |
no |
null |
成功した場合の結果 |
success.performance |
list[KeyVal] | null |
no |
null |
パフォーマンス情報のリスト |
success.msg |
str | null |
no |
null |
処理結果のメッセージ |
warn |
dict[str, any] | Data | str | bool | null |
no |
null |
警告がある場合の結果 |
warn.performance |
list[KeyVal] | null |
no |
null |
パフォーマンス情報のリスト |
error |
dict[str, any] | Data | str | bool | null |
no |
null |
エラーがある場合の結果 |
error.performance |
list[KeyVal] | null |
no |
null |
パフォーマンス情報のリスト |
schema |
dict[str, any] | null |
no |
null |
スキーマ情報 |
end |
bool | null |
no |
null |
終了フラグ |
web ( gencert ) : cmdbox -m web -c gencert <Option>
Generate a self-signed certificate for simple implementation of SSL in web mode.
Option |
Type |
Multi |
Required |
Default |
Choices |
Description |
|---|---|---|---|---|---|---|
--webhost <webhost> |
str |
required |
localhost |
Specify the host name to be specified as the CN (Common Name) of the self-signed certificate. |
||
--output_cert <output_cert> |
file |
Specify the self-signed certificate file to be output.If omitted, the hostname specified in the webhost option .crt will be output. |
||||
--output_cert_format <output_cert_format> |
str |
PEM |
DER | PEM |
Specifies the file format of the self-signed certificate to be output. |
||
--output_pkey <output_pkey> |
file |
Specifies the public key file of the self-signed certificate to output. If omitted, the output will be in the hostname specified in the `webhost option .pkey. |
||||
--output_pkey_format <output_pkey_format> |
str |
PEM |
DER | PEM |
Specifies the file format of the public key of the self-signed certificate to be output. |
||
--output_key <output_key> |
file |
Specifies the private key file of the self-signed certificate to be output.If omitted, the hostname specified in the webhost option .key will be output. |
||||
--output_key_format <output_key_format> |
str |
PEM |
DER | PEM |
Specifies the private key file format of the output self-signed certificate. |
||
--overwrite <overwrite> |
bool |
False |
True | False |
Overwrites the self-signed certificate file to be output if it exists. |
Output Schema
This command implements output_schema() returning Result model.
{
"success": {
"performance": [
{
"key": "string",
"value": null
}
],
"data": "string"
},
"warn": {},
"error": {},
"schema": {},
"end": false
}
Field |
Type |
Required |
Default |
Description |
|---|---|---|---|---|
success |
Data | null |
no |
null |
成功した場合の結果 |
success.performance |
list[KeyVal] | null |
no |
null |
パフォーマンス情報のリスト |
success.data |
str | null |
no |
null |
処理結果のデータ |
warn |
dict[str, any] | Data | str | bool | null |
no |
null |
警告がある場合の結果 |
warn.performance |
list[KeyVal] | null |
no |
null |
パフォーマンス情報のリスト |
error |
dict[str, any] | Data | str | bool | null |
no |
null |
エラーがある場合の結果 |
error.performance |
list[KeyVal] | null |
no |
null |
パフォーマンス情報のリスト |
schema |
dict[str, any] | null |
no |
null |
スキーマ情報 |
end |
bool | null |
no |
null |
終了フラグ |
web ( genpass ) : cmdbox -m web -c genpass <Option>
Generates a password string that can be used in web mode.
Option |
Type |
Multi |
Required |
Default |
Choices |
Description |
|---|---|---|---|---|---|---|
--pass_length <pass_length> |
int |
16 |
Specifies the length of the password. |
|||
--pass_count <pass_count> |
int |
5 |
Specify the number of passwords to be generated. |
|||
--use_alphabet <use_alphabet> |
str |
both |
notuse | upper | lower | both |
Specifies the type of alphabet used for the password. notuse , upper , lower , both can be specified. |
||
--use_number <use_number> |
str |
use |
notuse | use |
Specify the type of number to be used for the password. notuse , use can be specified. |
||
--use_symbol <use_symbol> |
str |
use |
notuse | use |
Specifies the type of symbol used in the password. notuse , use can be specified. |
||
--similar <similar> |
str |
exclude |
exclude | include |
Specifies whether certain similar characters should be used. exclude , include can be specified. |
Output Schema
This command implements output_schema() returning Result model.
{
"success": {
"performance": [
{
"key": "string",
"value": null
}
],
"passwords": [
"string"
]
},
"warn": {},
"error": {},
"schema": {},
"end": false
}
Field |
Type |
Required |
Default |
Description |
|---|---|---|---|---|
success |
Data | null |
no |
null |
成功した場合の結果 |
success.performance |
list[KeyVal] | null |
no |
null |
パフォーマンス情報のリスト |
success.passwords |
list[str] | null |
no |
null |
生成されたパスワードリスト |
warn |
dict[str, any] | Data | str | bool | null |
no |
null |
警告がある場合の結果 |
warn.performance |
list[KeyVal] | null |
no |
null |
パフォーマンス情報のリスト |
error |
dict[str, any] | Data | str | bool | null |
no |
null |
エラーがある場合の結果 |
error.performance |
list[KeyVal] | null |
no |
null |
パフォーマンス情報のリスト |
schema |
dict[str, any] | null |
no |
null |
スキーマ情報 |
end |
bool | null |
no |
null |
終了フラグ |
web ( group_add ) : cmdbox -m web -c group_add <Option>
Add a group in Web mode.
Option |
Type |
Multi |
Required |
Default |
Choices |
Description |
|---|---|---|---|---|---|---|
--group_id <group_id> |
str |
required |
Specify the group ID. Do not duplicate other groups. |
|||
--group_name <group_name> |
str |
required |
Specify a group name. Do not duplicate other groups. |
|||
--group_home <group_home> |
str |
required |
Specify the home directory for the group. |
|||
--group_parent <group_parent> |
str |
Specifies the parent group name. |
||||
--signin_file <signin_file> |
file |
required |
.cmdbox/user_list.yml |
Specify a file containing users and passwords with which they can signin.Typically, specify '.cmdbox/user_list.yml'. |
Output Schema
This command implements output_schema() returning Result model.
{
"success": {
"performance": [
{
"key": "string",
"value": null
}
],
"data": "string"
},
"warn": {},
"error": {},
"schema": {},
"end": false
}
Field |
Type |
Required |
Default |
Description |
|---|---|---|---|---|
success |
Data | null |
no |
null |
成功した場合の結果 |
success.performance |
list[KeyVal] | null |
no |
null |
パフォーマンス情報のリスト |
success.data |
str | null |
no |
null |
処理結果のデータ |
warn |
dict[str, any] | Data | str | bool | null |
no |
null |
警告がある場合の結果 |
warn.performance |
list[KeyVal] | null |
no |
null |
パフォーマンス情報のリスト |
error |
dict[str, any] | Data | str | bool | null |
no |
null |
エラーがある場合の結果 |
error.performance |
list[KeyVal] | null |
no |
null |
パフォーマンス情報のリスト |
schema |
dict[str, any] | null |
no |
null |
スキーマ情報 |
end |
bool | null |
no |
null |
終了フラグ |
web ( group_del ) : cmdbox -m web -c group_del <Option>
Del a group in Web mode.
Option |
Type |
Multi |
Required |
Default |
Choices |
Description |
|---|---|---|---|---|---|---|
--group_id <group_id> |
str |
required |
Specify the group ID. Do not duplicate other groups. |
|||
--signin_file <signin_file> |
file |
required |
.cmdbox/user_list.yml |
Specify a file containing users and passwords with which they can signin.Typically, specify '.cmdbox/user_list.yml'. |
Output Schema
This command implements output_schema() returning Result model.
{
"success": {
"performance": [
{
"key": "string",
"value": null
}
],
"data": "string"
},
"warn": {},
"error": {},
"schema": {},
"end": false
}
Field |
Type |
Required |
Default |
Description |
|---|---|---|---|---|
success |
Data | null |
no |
null |
成功した場合の結果 |
success.performance |
list[KeyVal] | null |
no |
null |
パフォーマンス情報のリスト |
success.data |
str | null |
no |
null |
処理結果のデータ |
warn |
dict[str, any] | Data | str | bool | null |
no |
null |
警告がある場合の結果 |
warn.performance |
list[KeyVal] | null |
no |
null |
パフォーマンス情報のリスト |
error |
dict[str, any] | Data | str | bool | null |
no |
null |
エラーがある場合の結果 |
error.performance |
list[KeyVal] | null |
no |
null |
パフォーマンス情報のリスト |
schema |
dict[str, any] | null |
no |
null |
スキーマ情報 |
end |
bool | null |
no |
null |
終了フラグ |
web ( group_edit ) : cmdbox -m web -c group_edit <Option>
Edit a group in Web mode.
Option |
Type |
Multi |
Required |
Default |
Choices |
Description |
|---|---|---|---|---|---|---|
--group_id <group_id> |
str |
required |
Specify the group ID. Do not duplicate other groups. |
|||
--group_name <group_name> |
str |
required |
Specify a group name. Do not duplicate other groups. |
|||
--group_parent <group_parent> |
str |
Specifies the parent group name. |
||||
--signin_file <signin_file> |
file |
required |
.cmdbox/user_list.yml |
Specify a file containing users and passwords with which they can signin.Typically, specify '.cmdbox/user_list.yml'. |
Output Schema
This command implements output_schema() returning Result model.
{
"success": {
"performance": [
{
"key": "string",
"value": null
}
],
"data": "string"
},
"warn": {},
"error": {},
"schema": {},
"end": false
}
Field |
Type |
Required |
Default |
Description |
|---|---|---|---|---|
success |
Data | null |
no |
null |
成功した場合の結果 |
success.performance |
list[KeyVal] | null |
no |
null |
パフォーマンス情報のリスト |
success.data |
str | null |
no |
null |
処理結果のデータ |
warn |
dict[str, any] | Data | str | bool | null |
no |
null |
警告がある場合の結果 |
warn.performance |
list[KeyVal] | null |
no |
null |
パフォーマンス情報のリスト |
error |
dict[str, any] | Data | str | bool | null |
no |
null |
エラーがある場合の結果 |
error.performance |
list[KeyVal] | null |
no |
null |
パフォーマンス情報のリスト |
schema |
dict[str, any] | null |
no |
null |
スキーマ情報 |
end |
bool | null |
no |
null |
終了フラグ |
web ( group_list ) : cmdbox -m web -c group_list <Option>
Get a list of users in Web mode.
Option |
Type |
Multi |
Required |
Default |
Choices |
Description |
|---|---|---|---|---|---|---|
--group_name <group_name> |
str |
Retrieved by specifying a group name. If omitted, all groups are retrieved. |
||||
--signin_file <signin_file> |
file |
required |
.cmdbox/user_list.yml |
Specify a file containing users and passwords with which they can signin.Typically, specify '.cmdbox/user_list.yml'. |
Output Schema
This command implements output_schema() returning Result model.
{
"success": {
"performance": [
{
"key": "string",
"value": null
}
],
"data": [
{
"gid": "string",
"name": "string",
"home": "string",
"parent": "string"
}
]
},
"warn": {},
"error": {},
"schema": {},
"end": false
}
Field |
Type |
Required |
Default |
Description |
|---|---|---|---|---|
success |
Data | null |
no |
null |
成功した場合の結果 |
success.performance |
list[KeyVal] | null |
no |
null |
パフォーマンス情報のリスト |
success.data |
list[GroupRecord] | null |
no |
null |
処理結果のデータ |
warn |
dict[str, any] | Data | str | bool | null |
no |
null |
警告がある場合の結果 |
warn.performance |
list[KeyVal] | null |
no |
null |
パフォーマンス情報のリスト |
error |
dict[str, any] | Data | str | bool | null |
no |
null |
エラーがある場合の結果 |
error.performance |
list[KeyVal] | null |
no |
null |
パフォーマンス情報のリスト |
schema |
dict[str, any] | null |
no |
null |
スキーマ情報 |
end |
bool | null |
no |
null |
終了フラグ |
web ( start ) : cmdbox -m web -c start <Option>
Start Web mode.
Option |
Type |
Multi |
Required |
Default |
Choices |
Description |
|---|---|---|---|---|---|---|
--host <host> |
str |
required |
localhost |
Specify the service host of the Redis server. |
||
--port <port> |
int |
required |
6379 |
Specify the service port of the Redis server. |
||
--password <password> |
passwd |
required |
password |
Specify the access password of the Redis server (optional). If omitted, password is used. |
||
--svname <svname> |
str |
required |
cmdbox |
Specify the service name of the inference server. If omitted, server is used. |
||
--data <data> |
dir |
C:Usershama.cmdbox |
When omitted, $HONE/.cmdbox is used. |
|||
--allow_host <allow_host> |
str |
0.0.0.0 |
If omitted, 0.0.0.0 is used. |
|||
--listen_port <listen_port> |
int |
8081 |
If omitted, 8081 is used. |
|||
--ssl_listen_port <ssl_listen_port> |
int |
8443 |
If omitted, 8443 is used. |
|||
--ssl_cert <ssl_cert> |
file |
Specify the SSL server certificate file. |
||||
--ssl_key <ssl_key> |
file |
Specify the SSL server private key file. |
||||
--ssl_keypass <ssl_keypass> |
str |
Specify the composite password for the SSL server private key file. |
||||
--ssl_ca_certs <ssl_ca_certs> |
file |
Specify the SSL server CA certificate file. |
||||
--signin_file <signin_file> |
file |
required |
.cmdbox/user_list.yml |
Specify a file containing users and passwords with which they can signin.Typically, specify '.cmdbox/user_list.yml'. |
||
--session_domain <session_domain> |
str |
Specify the domain for which the signed-in user's session is valid. |
||||
--session_path <session_path> |
str |
/ |
Specify the session timeout in seconds for signed-in users. |
|||
--session_secure <session_secure> |
bool |
False |
True | False |
Set the Secure flag for the signed-in user's session. |
||
--session_timeout <session_timeout> |
int |
900 |
Specify the session timeout in seconds for signed-in users. |
|||
--gunicorn_workers <gunicorn_workers> |
int |
6 |
Specifies the number of gunicorn workers, valid only in Linux environment. If -1 or unspecified, the number of CPUs is used. |
|||
--gunicorn_timeout <gunicorn_timeout> |
int |
900 |
Specify the timeout duration of the gunicorn worker in seconds. |
|||
--client_only <client_only> |
bool |
False |
True | False |
Do not make connections to the server. |
||
--outputs_key <outputs_key> |
str |
multi |
Specify items to be displayed on the showimg and webcap screens. If omitted, all items are displayed. |
|||
--doc_root <doc_root> |
dir |
Document root for custom files. URL mapping from the path of a folder-specified custom file with the path of doc_root removed. |
||||
--gui_html <gui_html> |
file |
Specify gui.html. If omitted, the cmdbox built-in HTML file is used. |
||||
--filer_html <filer_html> |
file |
Specify filer.html. If omitted, the cmdbox built-in HTML file is used. |
||||
--result_html <result_html> |
file |
Specify result.html. If omitted, the cmdbox built-in HTML file is used. |
||||
--users_html <users_html> |
file |
Specify users.html. If omitted, the cmdbox built-in HTML file is used. |
||||
--agent_html <agent_html> |
file |
Specify agent.html. If omitted, the cmdbox built-in HTML file is used. |
||||
--assets <assets> |
file |
multi |
Specify the asset file required when using html files. |
|||
--signin_html <signin_html> |
file |
Specify signin.html. If omitted, the cmdbox built-in HTML file is used. |
Output Schema
This command implements output_schema() returning Result model.
{
"success": {
"performance": [
{
"key": "string",
"value": null
}
],
"data": "string"
},
"warn": {},
"error": {},
"schema": {},
"end": false
}
Field |
Type |
Required |
Default |
Description |
|---|---|---|---|---|
success |
Data | null |
no |
null |
成功した場合の結果 |
success.performance |
list[KeyVal] | null |
no |
null |
パフォーマンス情報のリスト |
success.data |
str | null |
no |
null |
処理結果のデータ |
warn |
dict[str, any] | Data | str | bool | null |
no |
null |
警告がある場合の結果 |
warn.performance |
list[KeyVal] | null |
no |
null |
パフォーマンス情報のリスト |
error |
dict[str, any] | Data | str | bool | null |
no |
null |
エラーがある場合の結果 |
error.performance |
list[KeyVal] | null |
no |
null |
パフォーマンス情報のリスト |
schema |
dict[str, any] | null |
no |
null |
スキーマ情報 |
end |
bool | null |
no |
null |
終了フラグ |
web ( stop ) : cmdbox -m web -c stop <Option>
Stop Web mode.
Option |
Type |
Multi |
Required |
Default |
Choices |
Description |
|---|---|---|---|---|---|---|
--data <data> |
dir |
C:Usershama.cmdbox |
When omitted, $HONE/.cmdbox is used. |
Output Schema
This command implements output_schema() returning Result model.
{
"success": {
"performance": [
{
"key": "string",
"value": null
}
],
"data": "string"
},
"warn": {},
"error": {},
"schema": {},
"end": false
}
Field |
Type |
Required |
Default |
Description |
|---|---|---|---|---|
success |
Data | null |
no |
null |
成功した場合の結果 |
success.performance |
list[KeyVal] | null |
no |
null |
パフォーマンス情報のリスト |
success.data |
str | null |
no |
null |
処理結果のデータ |
warn |
dict[str, any] | Data | str | bool | null |
no |
null |
警告がある場合の結果 |
warn.performance |
list[KeyVal] | null |
no |
null |
パフォーマンス情報のリスト |
error |
dict[str, any] | Data | str | bool | null |
no |
null |
エラーがある場合の結果 |
error.performance |
list[KeyVal] | null |
no |
null |
パフォーマンス情報のリスト |
schema |
dict[str, any] | null |
no |
null |
スキーマ情報 |
end |
bool | null |
no |
null |
終了フラグ |
web ( user_add ) : cmdbox -m web -c user_add <Option>
Add a user in Web mode.
Option |
Type |
Multi |
Required |
Default |
Choices |
Description |
|---|---|---|---|---|---|---|
--user_id <user_id> |
int |
required |
Specify the user ID. Do not duplicate other users. |
|||
--user_name <user_name> |
str |
required |
Specify a user name. Do not duplicate other users. |
|||
--user_pass <user_pass> |
str |
Specify the user password. |
||||
--user_pass_hash <user_pass_hash> |
str |
sha1 |
oauth2 | saml | plain | md5 | sha1 | sha256 |
Specifies the hash algorithm for user passwords. |
||
--user_email <user_email> |
str |
Specify the user email. Required when user_pass_hash is oauth2 or saml. |
||||
--user_group <user_group> |
str |
multi |
required |
Specifies the groups to which the user belongs. |
||
--user_home <user_home> |
str |
required |
Specify the home directory for the user. |
|||
--signin_file <signin_file> |
file |
required |
.cmdbox/user_list.yml |
Specify a file containing users and passwords with which they can signin.Typically, specify '.cmdbox/user_list.yml'. |
Output Schema
This command implements output_schema() returning Result model.
{
"success": {
"performance": [
{
"key": "string",
"value": null
}
],
"data": "string"
},
"warn": {},
"error": {},
"schema": {},
"end": false
}
Field |
Type |
Required |
Default |
Description |
|---|---|---|---|---|
success |
Data | null |
no |
null |
成功した場合の結果 |
success.performance |
list[KeyVal] | null |
no |
null |
パフォーマンス情報のリスト |
success.data |
str | null |
no |
null |
処理結果のデータ |
warn |
dict[str, any] | Data | str | bool | null |
no |
null |
警告がある場合の結果 |
warn.performance |
list[KeyVal] | null |
no |
null |
パフォーマンス情報のリスト |
error |
dict[str, any] | Data | str | bool | null |
no |
null |
エラーがある場合の結果 |
error.performance |
list[KeyVal] | null |
no |
null |
パフォーマンス情報のリスト |
schema |
dict[str, any] | null |
no |
null |
スキーマ情報 |
end |
bool | null |
no |
null |
終了フラグ |
web ( user_del ) : cmdbox -m web -c user_del <Option>
Delete a user in Web mode.
Option |
Type |
Multi |
Required |
Default |
Choices |
Description |
|---|---|---|---|---|---|---|
--user_id <user_id> |
int |
required |
Specify the user ID. |
|||
--signin_file <signin_file> |
file |
required |
.cmdbox/user_list.yml |
Specify a file containing users and passwords with which they can signin.Typically, specify '.cmdbox/user_list.yml'. |
Output Schema
This command implements output_schema() returning Result model.
{
"success": {
"performance": [
{
"key": "string",
"value": null
}
],
"data": "string"
},
"warn": {},
"error": {},
"schema": {},
"end": false
}
Field |
Type |
Required |
Default |
Description |
|---|---|---|---|---|
success |
Data | null |
no |
null |
成功した場合の結果 |
success.performance |
list[KeyVal] | null |
no |
null |
パフォーマンス情報のリスト |
success.data |
str | null |
no |
null |
処理結果のデータ |
warn |
dict[str, any] | Data | str | bool | null |
no |
null |
警告がある場合の結果 |
warn.performance |
list[KeyVal] | null |
no |
null |
パフォーマンス情報のリスト |
error |
dict[str, any] | Data | str | bool | null |
no |
null |
エラーがある場合の結果 |
error.performance |
list[KeyVal] | null |
no |
null |
パフォーマンス情報のリスト |
schema |
dict[str, any] | null |
no |
null |
スキーマ情報 |
end |
bool | null |
no |
null |
終了フラグ |
web ( user_edit ) : cmdbox -m web -c user_edit <Option>
Edit users in Web mode.
Option |
Type |
Multi |
Required |
Default |
Choices |
Description |
|---|---|---|---|---|---|---|
--user_id <user_id> |
int |
required |
Specify the user ID. |
|||
--user_name <user_name> |
str |
required |
Specify a user name. Do not duplicate other users. |
|||
--user_pass <user_pass> |
str |
Specify the user password. |
||||
--user_pass_hash <user_pass_hash> |
str |
sha1 |
oauth2 | saml | plain | md5 | sha1 | sha256 |
Specifies the hash algorithm for user passwords. |
||
--user_email <user_email> |
str |
Specify the user email. Required when user_pass_hash is oauth2 or saml. |
||||
--user_group <user_group> |
str |
multi |
required |
Specifies the groups to which the user belongs. |
||
--user_home <user_home> |
str |
required |
Specify the home directory for the user. |
|||
--signin_file <signin_file> |
file |
required |
.cmdbox/user_list.yml |
Specify a file containing users and passwords with which they can signin.Typically, specify '.cmdbox/user_list.yml'. |
Output Schema
This command implements output_schema() returning Result model.
{
"success": {
"performance": [
{
"key": "string",
"value": null
}
],
"data": "string"
},
"warn": {},
"error": {},
"schema": {},
"end": false
}
Field |
Type |
Required |
Default |
Description |
|---|---|---|---|---|
success |
Data | null |
no |
null |
成功した場合の結果 |
success.performance |
list[KeyVal] | null |
no |
null |
パフォーマンス情報のリスト |
success.data |
str | null |
no |
null |
処理結果のデータ |
warn |
dict[str, any] | Data | str | bool | null |
no |
null |
警告がある場合の結果 |
warn.performance |
list[KeyVal] | null |
no |
null |
パフォーマンス情報のリスト |
error |
dict[str, any] | Data | str | bool | null |
no |
null |
エラーがある場合の結果 |
error.performance |
list[KeyVal] | null |
no |
null |
パフォーマンス情報のリスト |
schema |
dict[str, any] | null |
no |
null |
スキーマ情報 |
end |
bool | null |
no |
null |
終了フラグ |
web ( user_list ) : cmdbox -m web -c user_list <Option>
Get a list of users in Web mode.
Option |
Type |
Multi |
Required |
Default |
Choices |
Description |
|---|---|---|---|---|---|---|
--user_name <user_name> |
str |
Retrieved by specifying a user name. If omitted, all users are retrieved. |
||||
--signin_file <signin_file> |
file |
required |
.cmdbox/user_list.yml |
Specify a file containing users and passwords with which they can signin.Typically, specify '.cmdbox/user_list.yml'. |
Output Schema
This command implements output_schema() returning Result model.
{
"success": {
"performance": [
{
"key": "string",
"value": null
}
],
"data": [
{
"uid": "string",
"name": "string",
"password": "string",
"hash": "string",
"email": "string",
"groups": [
"string"
],
"home": "string"
}
]
},
"warn": {},
"error": {},
"schema": {},
"end": false
}
Field |
Type |
Required |
Default |
Description |
|---|---|---|---|---|
success |
Data | null |
no |
null |
成功した場合の結果 |
success.performance |
list[KeyVal] | null |
no |
null |
パフォーマンス情報のリスト |
success.data |
list[UserRecord] | null |
no |
null |
処理結果のデータ |
warn |
dict[str, any] | Data | str | bool | null |
no |
null |
警告がある場合の結果 |
warn.performance |
list[KeyVal] | null |
no |
null |
パフォーマンス情報のリスト |
error |
dict[str, any] | Data | str | bool | null |
no |
null |
エラーがある場合の結果 |
error.performance |
list[KeyVal] | null |
no |
null |
パフォーマンス情報のリスト |
schema |
dict[str, any] | null |
no |
null |
スキーマ情報 |
end |
bool | null |
no |
null |
終了フラグ |