Displays environment variables.
msh(tsa********)> show env
Specified parameter at time of command execution unknown.
Shows list of environment variables for msh set at command execution.
Output examples for commands are shown below.
msh(tsa********)> show env
proxy_addr : proxy.example.jp
proxy_port : 8080
domain : domain.example.jp
path : /api/resource
access_key : access_key_string
access_key_secret : access_key_secret_string
user_code : tsa********
ssl_verify : true
msh(tsa********)>
Sets environment variables.
msh(tsa********)> set env [access_key <Access Key>] [access_key_secret <Access Key Secret>] [domain <Domain>] [path <Path>] [user_code <User Code>] [proxy_addr <Proxy Address>] [proxy_port <Proxy Port>] [ssl_verify <SSL Verify>] [offset_minute <Offset Minute>]
Parameter |
Description |
|---|---|
(Optional) <Access Key> |
Access key for API execution |
(Optional) <Access Key Secret> |
Password for API execution |
(Optional) <Domain> |
Domain of the API resource |
(Optional) <Path> |
Path of the API resource |
(Optional) <User Code> |
Management code |
(Optional) <Proxy Address> |
IP address of the proxy server |
(Optional) <Proxy Port> |
Port number of the proxy server |
(Optional) <SSL Verify> |
Whether or not to validate certificate |
(Optional) <Offset Minute> |
Offset of timezone (-720 - 840) |
Set the environment variables required to execute msh and display the updated environment variables. Values updated using this command are not saved in the mshrc. Specified parameters cannot be set using the same names as option names.
Output examples for commands are shown below.
To update Variable parameters
msh(tsa********)> set env access_key key domain sacm.example.jp
proxy_addr : proxy.example.jp
proxy_port : 8080
domain : sacm.example.jp
path : /api/resource
access_key : key
access_key_secret : access_key_secret_string
user_code : tsa********
msh(tsa********)>
Update environment variables to null.
msh(tsa********)> unset env [access_key] [access_key_secret] [domain] [path] [user_code] [proxy_addr] [proxy_port] [ssl_verify] [offset_minute]
No parameters to specify.
Delete parameters set as the environment variables required to execute msh and display the updated environment variables. Values updated using this command are not saved in the mshrc.
Output examples for commands are shown below.
To delete variable parameters
msh(tsa********)> unset env access_key access_key_secret
proxy_addr : proxy.example.jp
proxy_port : 8080
domain : sacm.example.jp
path : /api/resource
access_key :
access_key_secret :
user_code : tsa********
msh(tsa********)>
Parameter / Option |
Default value |
|---|---|
access_key |
(Empty string) |
access_key_secret |
(Empty string) |
domain |
(Empty string) |
path |
(Empty string) |
user_code |
(Empty string) |
proxy_addr |
(Empty string) |
proxy_port |
(Empty string) |
ssl_verify |
(Empty string) |
offset_minute |
(Empty string) |
For the msh environment variables, the configuration file (mshrc) is read and reflected in the environment variables.
msh(tsa********)> show mshrc [<mshrc File>]
Parameter |
Description |
|---|---|
(Optional) <mshrc File> |
Read mshrc file |
Display a list of files where the prefix below ~/.msh/ is “mshrc.”. Specifying an mshrc filename displays the content of the file.
Output examples for commands are shown below.
To display a list of .mshrc files
msh(tsa********)> show mshrc
mshrc
mshrc.other
mshrc.x1
mshrc.b1
msh(tsa********)>
To display the content of a specific .mshrc file
msh(tsa********)> show mshrc other.mshrc
proxy_addr : proxy.example2.jp
proxy_port : 8080
domain : sacm.example2.jp
path : /api/resource
access_key : access_key_string2
access_key_secret : access_key_string2
user_code : tsa********
msh(tsa********)>
The configuration file (mshrc) is read to update the msh environment variables.
msh(tsa********)> set mshrc <mshrc File>
Parameter |
Description |
|---|---|
<mshrc File> |
mshrc file to be read |
Files that are candidates for being read via the set mshrc command are files with the prefix mshrc below ~/.msh/. When the command is executed, the msh environment variables are updated and then the updated environment variables are displayed.
Output examples for commands are shown below.
To update Variable parameters
msh(tsa********)> set mshrc mshrc.other
proxy_addr : proxy.example2.jp
proxy_port : 8080
domain : sacm.example2.jp
path : /api/resource
access_key : access_key_string2
access_key_secret : access_key_string2
user_code : tsa********
msh(tsa********)>
Displays a list of commands that can be executed via msh or an explanation for a specified command.
msh(tsa********)> help [<Command>]
Parameter |
Description |
|---|---|
(Optional) <Command> |
Names of commands to display explanations |
Output examples for commands are shown below.
Command list
msh(tsa********)> help
show user - show the list of managed sacm user code
show sa - show the service adapter list or service adapter info
set sa - set the service adapter information
unset sa - unset the service adapter information
show config - show the service adapter config
set config - set service adapter config
show module - show the available modules
set module - set the specified version module
ping - ping command
traceroute - traceroute command
read-storage - read-storage command
reboot - reboot command
read-status - read-status command
clear-status - clear-status command
md-command - md-command command
show request - show the result of sacm's executed task
show event - show the event of sacm
show monitor - show the monitor config
add monitor - add monitor settings
set monitor - set monitor settings
unset monitor - unset monitor settings
delete monitor - delete monitor settings
show sagroup - show the service adapter group info
add sagroup - add the service adapter group
set sagroup - set the value of service adapter group
unset sagroup - unset the value of service adapter group
delete sagroup - delete the service adapter group
show template-set - show the template set info
add template-set - add the template set
set template-set - set the template set value information
unset template-set - unset the template set value information
delete template-set - delete the template set
show template-variable - show the template set variable info
add template-variable - add the template set variable
set template-variable - set value of the template set variable information
delete template-variable - delete the template set variable
show template-config - show the template config info
set template-config - set the template config
delete template-config - delete the template config
show env - show the environment variable
set env - set environment variable
unset env - unset environment variable
show mshrc - show the specified mshrc (deployed in ~/.msh/)
set mshrc - set the specified mshrc (deployed in ~/.msh/)
help - show help
msh(tsa********)>
Execute help command for which the command name was specified
msh(tsa********)> help ping
Name :
ping - ping command
SYNOPSIS:
$ ping <SA Code> <IPAddress> [size <size>] [count <count>] [targettime <targetTime>]