MCPcopy Create free account
hub / github.com/cloudwan/gohan / getGohanClientCommand

Function getGohanClientCommand

cli/cli.go:88–173  ·  view source on GitHub ↗
()

Source from the content-addressed store, hash-verified

86}
87
88func getGohanClientCommand() cli.Command {
89 return cli.Command{
90 Name: "client",
91 Usage: "Manage Gohan resources",
92 SkipFlagParsing: true,
93 HideHelp: true,
94 Description: `gohan client schema_id command [arguments...]
95
96COMMANDS:
97 list List all resources
98 show Show resource details
99 create Create resource
100 set Update resource
101 delete Delete resource
102
103ARGUMENTS:
104 There are two types of arguments:
105 - named:
106 they are in '--name value' format and should be specified directly after
107 command name.
108 If you want to pass JSON null value, it should be written as: '--name "<null>"'.
109
110 Special named arguments:
111 --output-format [json/table] - specifies in which format results should be shown
112 --verbosity [0-3] - specifies how much debug info Gohan Client should show (default 0)
113 --fields [field1,field2] - specifies which fields should be visible (default all)
114 - unnamed:
115 they are in 'value' format and should be specified at the end of the line,
116 after all named arguments. At the moment only 'id' argument in 'show',
117 'set' and 'delete' commands are available in this format.
118
119 Identifying resources:
120 It is possible to identify resources with its ID and Name.
121
122 Examples:
123 gohan client network show network-id
124 gohan client network show "Network Name"
125 gohan client subnet create --network "Network Name"
126 gohan client subnet create --network network-id
127 gohan client subnet create --network_id network-id
128
129CONFIGURATION:
130 Configuration is available by environment variables:
131 * Keystone username - OS_USERNAME
132 * Keystone password - OS_PASSWORD
133 * Keystone tenant name or tenant id - OS_TENANT_NAME or OS_TENANT_ID
134 * Keystone url - OS_AUTH_URL
135 * Gohan service name in keystone - GOHAN_SERVICE_NAME
136 * Gohan region in keystone - GOHAN_REGION
137 * Gohan schema URL - GOHAN_SCHEMA_URL
138 * Should Client cache schemas (default - true) - GOHAN_CACHE_SCHEMAS
139 * Cache expiration time (in format 1h20m10s - default 5m) - GOHAN_CACHE_TIMEOUT
140 * Cache path (default - /tmp/.cached-gohan-schemas) - GOHAN_CACHE_PATH
141 * In which format results should be shown, see --output-format - GOHAN_OUTPUT_FORMAT
142 * How much debug info Gohan Client should show, see --verbosity - GOHAN_VERBOSITY
143 * Which columns should be visible in results, see --fields - GOHAN_FIELDS
144 Additional options for Keystone v3 only:
145 * Keystone domain name or domain id - OS_DOMAIN_NAME or OS_DOMAIN_ID

Callers 1

RunFunction · 0.85

Calls 3

ExecuteCommandMethod · 0.95
ArgsMethod · 0.80
GetMethod · 0.65

Tested by

no test coverage detected