node
Node
$ ./osctrl-cli node -h
NAME:
osctrl-cli node - Commands for nodes
USAGE:
osctrl-cli node [command [command options]]
COMMANDS:
delete, d Delete and archive an existing node
tag, t Tag an existing node
list, l List enrolled nodes
show, s Show an existing node
lookup, f Lookup existing nodes by identifier (UUID, hostname or localname)
OPTIONS:
--help, -h show help
Delete node
$ ./osctrl-cli node delete -h
NAME:
osctrl-cli node delete - Delete and archive an existing node
USAGE:
osctrl-cli node delete [options]
OPTIONS:
--uuid string, -u string Node UUID to be deleted
--env string, -e string Environment to be used
--help, -h show help
GLOBAL OPTIONS:
--db, -d Connect to local osctrl DB using YAML config file [$DB_CONFIG]
--api, -a Connect to remote osctrl using JSON config file [$API_CONFIG]
--api-file FILE, -A FILE Load API JSON configuration from FILE (default: "osctrl-api.json") [$API_CONFIG_FILE]
--api-url string, -U string The URL for osctrl API to be used [$API_URL]
--api-token string, -T string Token to authenticate with the osctrl API [$API_TOKEN]
--db-file FILE, -D FILE Load DB YAML configuration from FILE [$DB_CONFIG_FILE]
--db-host string Backend host to be connected to (default: "127.0.0.1") [$DB_HOST]
--db-port int Backend port to be connected to (default: 5432) [$DB_PORT]
--db-name string Database name to be used in the backend (default: "osctrl") [$DB_NAME]
--db-user string Username to be used for the backend (default: "postgres") [$DB_USER]
--db-pass string Password to be used for the backend (default: "postgres") [$DB_PASS]
--db-max-idle-conns int Maximum number of connections in the idle connection pool (default: 20) [$DB_MAX_IDLE_CONNS]
--db-max-open-conns int Maximum number of open connections to the database (default: 100) [$DB_MAX_OPEN_CONNS]
--db-conn-max-lifetime int Maximum amount of time a connection may be reused (default: 30) [$DB_CONN_MAX_LIFETIME]
--insecure, -i Allow insecure server connections when using SSL
--verbose, -V Increase output verbosity for debugging
--output-format string, -o string Format to be used for data output (default: "pretty") [$OUTPUT_FORMAT]
--silent, -s Silent mode
--version, -v Print version information
Tag node
$ ./osctrl-cli node tag -h
NAME:
osctrl-cli node tag - Tag an existing node
USAGE:
osctrl-cli node tag [options]
OPTIONS:
--uuid string, -u string Node UUID to be tagged
--env string, -e string Environment to be used
--name string, -n string, --tag string, --tag-value string Tag name to be used. It will be created if does not exist
--tag-type string, --type string Tag type to be used. It can be 'env', 'uuid', 'platform', 'localname', 'tag' and 'custom'
--custom string, --tag-custom string, -c string Custom tag value to be used, if tag-type is set to 'custom'
--help, -h show help
GLOBAL OPTIONS:
--db, -d Connect to local osctrl DB using YAML config file [$DB_CONFIG]
--api, -a Connect to remote osctrl using JSON config file [$API_CONFIG]
--api-file FILE, -A FILE Load API JSON configuration from FILE (default: "osctrl-api.json") [$API_CONFIG_FILE]
--api-url string, -U string The URL for osctrl API to be used [$API_URL]
--api-token string, -T string Token to authenticate with the osctrl API [$API_TOKEN]
--db-file FILE, -D FILE Load DB YAML configuration from FILE [$DB_CONFIG_FILE]
--db-host string Backend host to be connected to (default: "127.0.0.1") [$DB_HOST]
--db-port int Backend port to be connected to (default: 5432) [$DB_PORT]
--db-name string Database name to be used in the backend (default: "osctrl") [$DB_NAME]
--db-user string Username to be used for the backend (default: "postgres") [$DB_USER]
--db-pass string Password to be used for the backend (default: "postgres") [$DB_PASS]
--db-max-idle-conns int Maximum number of connections in the idle connection pool (default: 20) [$DB_MAX_IDLE_CONNS]
--db-max-open-conns int Maximum number of open connections to the database (default: 100) [$DB_MAX_OPEN_CONNS]
--db-conn-max-lifetime int Maximum amount of time a connection may be reused (default: 30) [$DB_CONN_MAX_LIFETIME]
--insecure, -i Allow insecure server connections when using SSL
--verbose, -V Increase output verbosity for debugging
--output-format string, -o string Format to be used for data output (default: "pretty") [$OUTPUT_FORMAT]
--silent, -s Silent mode
--version, -v Print version information
List nodes
$ ./osctrl-cli node list -h
NAME:
osctrl-cli node list - List enrolled nodes
USAGE:
osctrl-cli node list [options]
OPTIONS:
--active, -a Show active nodes
--all, -A Show all nodes
--inactive, -i Show inactive nodes
--env string, -e string Environment to be used
--help, -h show help
GLOBAL OPTIONS:
--db, -d Connect to local osctrl DB using YAML config file [$DB_CONFIG]
--api, -a Connect to remote osctrl using JSON config file [$API_CONFIG]
--api-file FILE, -A FILE Load API JSON configuration from FILE (default: "osctrl-api.json") [$API_CONFIG_FILE]
--api-url string, -U string The URL for osctrl API to be used [$API_URL]
--api-token string, -T string Token to authenticate with the osctrl API [$API_TOKEN]
--db-file FILE, -D FILE Load DB YAML configuration from FILE [$DB_CONFIG_FILE]
--db-host string Backend host to be connected to (default: "127.0.0.1") [$DB_HOST]
--db-port int Backend port to be connected to (default: 5432) [$DB_PORT]
--db-name string Database name to be used in the backend (default: "osctrl") [$DB_NAME]
--db-user string Username to be used for the backend (default: "postgres") [$DB_USER]
--db-pass string Password to be used for the backend (default: "postgres") [$DB_PASS]
--db-max-idle-conns int Maximum number of connections in the idle connection pool (default: 20) [$DB_MAX_IDLE_CONNS]
--db-max-open-conns int Maximum number of open connections to the database (default: 100) [$DB_MAX_OPEN_CONNS]
--db-conn-max-lifetime int Maximum amount of time a connection may be reused (default: 30) [$DB_CONN_MAX_LIFETIME]
--insecure, -i Allow insecure server connections when using SSL
--verbose, -V Increase output verbosity for debugging
--output-format string, -o string Format to be used for data output (default: "pretty") [$OUTPUT_FORMAT]
--silent, -s Silent mode
--version, -v Print version information
Show node
$ ./osctrl-cli node show -h
NAME:
osctrl-cli node show - Show an existing node
USAGE:
osctrl-cli node show [options]
OPTIONS:
--uuid string, -u string Node UUID to be shown
--env string, -e string Environment to be used
--help, -h show help
GLOBAL OPTIONS:
--db, -d Connect to local osctrl DB using YAML config file [$DB_CONFIG]
--api, -a Connect to remote osctrl using JSON config file [$API_CONFIG]
--api-file FILE, -A FILE Load API JSON configuration from FILE (default: "osctrl-api.json") [$API_CONFIG_FILE]
--api-url string, -U string The URL for osctrl API to be used [$API_URL]
--api-token string, -T string Token to authenticate with the osctrl API [$API_TOKEN]
--db-file FILE, -D FILE Load DB YAML configuration from FILE [$DB_CONFIG_FILE]
--db-host string Backend host to be connected to (default: "127.0.0.1") [$DB_HOST]
--db-port int Backend port to be connected to (default: 5432) [$DB_PORT]
--db-name string Database name to be used in the backend (default: "osctrl") [$DB_NAME]
--db-user string Username to be used for the backend (default: "postgres") [$DB_USER]
--db-pass string Password to be used for the backend (default: "postgres") [$DB_PASS]
--db-max-idle-conns int Maximum number of connections in the idle connection pool (default: 20) [$DB_MAX_IDLE_CONNS]
--db-max-open-conns int Maximum number of open connections to the database (default: 100) [$DB_MAX_OPEN_CONNS]
--db-conn-max-lifetime int Maximum amount of time a connection may be reused (default: 30) [$DB_CONN_MAX_LIFETIME]
--insecure, -i Allow insecure server connections when using SSL
--verbose, -V Increase output verbosity for debugging
--output-format string, -o string Format to be used for data output (default: "pretty") [$OUTPUT_FORMAT]
--silent, -s Silent mode
--version, -v Print version information
Lookup node
$ ./osctrl-cli node lookup -h
NAME:
osctrl-cli node lookup - Lookup existing nodes by identifier (UUID, hostname or localname)
USAGE:
osctrl-cli node lookup [options]
OPTIONS:
--identifier string, --id string, -i string Node identifier to be looked up (UUID, hostname or localname)
--help, -h show help
GLOBAL OPTIONS:
--db, -d Connect to local osctrl DB using YAML config file [$DB_CONFIG]
--api, -a Connect to remote osctrl using JSON config file [$API_CONFIG]
--api-file FILE, -A FILE Load API JSON configuration from FILE (default: "osctrl-api.json") [$API_CONFIG_FILE]
--api-url string, -U string The URL for osctrl API to be used [$API_URL]
--api-token string, -T string Token to authenticate with the osctrl API [$API_TOKEN]
--db-file FILE, -D FILE Load DB YAML configuration from FILE [$DB_CONFIG_FILE]
--db-host string Backend host to be connected to (default: "127.0.0.1") [$DB_HOST]
--db-port int Backend port to be connected to (default: 5432) [$DB_PORT]
--db-name string Database name to be used in the backend (default: "osctrl") [$DB_NAME]
--db-user string Username to be used for the backend (default: "postgres") [$DB_USER]
--db-pass string Password to be used for the backend (default: "postgres") [$DB_PASS]
--db-max-idle-conns int Maximum number of connections in the idle connection pool (default: 20) [$DB_MAX_IDLE_CONNS]
--db-max-open-conns int Maximum number of open connections to the database (default: 100) [$DB_MAX_OPEN_CONNS]
--db-conn-max-lifetime int Maximum amount of time a connection may be reused (default: 30) [$DB_CONN_MAX_LIFETIME]
--insecure, -i Allow insecure server connections when using SSL
--verbose, -V Increase output verbosity for debugging
--output-format string, -o string Format to be used for data output (default: "pretty") [$OUTPUT_FORMAT]
--silent, -s Silent mode
--version, -v Print version information