3.3. Other Commands
3.3.1. .rhscshellrc Configuration Copy linkLink copied to clipboard!
Copy linkLink copied to clipboard!
The
.rhscshellrc configuration file contains options for connecting to the rhsc-shell. The .rhscshellrc file is available in the /home/[user name]/ directory.
| Name | Type | Description |
|---|---|---|
url
|
string
|
The address of the Red Hat Storage Console Application.
|
username
|
string
|
User name to be used to log in.
|
password
|
string
|
Password to be used for user name.
|
insecure
|
boolean
|
Toggles CA certificate requirement. The status is either
True or False.
|
autopage
|
boolean
|
Toggles pagination in the shell. The status is either
True or False.
|
filter
|
boolean
|
Toggles object filtering. Object filtering allows users to fetch objects according to their permissions. Only admin roles can toggle filtering off. The status is either
True or False.
|
--session-timeout | integer | The timeout period for connection. |
timeout
|
integer
|
Requests timeout. The default is
-1.
|
3.3.2. Clear the Screen Using clear Copy linkLink copied to clipboard!
Copy linkLink copied to clipboard!
Use the
clear command to clear the CLI screen as follows:
# clear
Example 3.9. Example for clear
Clear the screen:
[RHSC shell (connected)]# clear
3.3.3. Print Input Using echo Copy linkLink copied to clipboard!
Copy linkLink copied to clipboard!
Use the
echo command to print input to the screen. Use the $out variable to print the last shell command output.
# echo [input]
Example 3.10. Example for echo
Print input:
[RHSC shell (connected)]# echo "Example text!"
Print last output:
[RHSC shell (connected)]# echo $out
3.3.4. Show Last Status Using status Copy linkLink copied to clipboard!
Copy linkLink copied to clipboard!
Use the
status command to display the most recently run command status as follows:
# status
Example 3.11. Example for status
View the last status:
[RHSC shell (connected)]# status
last command status: 0 (OK)
3.3.5. Show CLI Information Using info Copy linkLink copied to clipboard!
Copy linkLink copied to clipboard!
Use the
info command to display environment connection details and version information as follows:
# info
Example 3.12. Example for info
View CLI information:
[RHSC shell (connected)]# info
backend version: 3.3
sdk version : 2.1
cli version : 2.1
python version : 2.6.6.final.0
entry point : https://www.example.com:8443/api
3.3.6. Test Connection Using ping Copy linkLink copied to clipboard!
Copy linkLink copied to clipboard!
Use the
ping command to test the connection to your Red Hat Storage Console Application. The command retrieves a remote resource and ensures the URL, username and password for the connection are correct.
# ping
Example 3.13. Example for ping
Test your connection:
[RHSC shell (connected)]# ping
success: RHSC manager could be reached OK.
3.3.7. Exit from the CLI Using exit Copy linkLink copied to clipboard!
Copy linkLink copied to clipboard!
Use the
exit command to leave the CLI as follows:
# exit
Example 3.14. Example for exit
Leave the CLI:
[RHSC shell (connected)]# exit
3.3.8. End of File Using EOF Copy linkLink copied to clipboard!
Copy linkLink copied to clipboard!
Use the
EOF command to leave the CLI shell using a Ctrl+D sequence.
# EOF
Example 3.15. Example for EOF
Leave the CLI shell:
[RHSC shell (connected)]# EOF
3.3.9. Show Help Using help Copy linkLink copied to clipboard!
Copy linkLink copied to clipboard!
Use the
help command displays help for CLI command and resource combinations as follows:
# help [command][resource][options]
Example 3.16. Examples for help
Get CLI help:
[RHSC shell (connected)]# help
Get help for the
add command:
[RHSC shell (connected)]# help add
Get help for the
add command on the cluster resource type:
[RHSC shell (connected)]# help add cluster