client
The egosh client sub-command manages EGO clients.
client list [-l] [-ll] [-c client_name] [-a alloc_ID] [-p consumer_name] [-r resource_name] [-t activity_ID]
Displays a list of the registered clients in the cluster, and information about each client, including the host name and port number, the channel, and whether the client is connected. Client names are truncated to 12 characters.
- -l
-
Provides the same information with a longer name field, if some are truncated when -l is not specified.
- -ll
-
Provides the same information as the -l option, and in comma-separated values (CSV) format.
- -c client_name
-
Specifies the client to which this action applies.
- -a alloc_ID
-
Lists the client who has allocated to the specified allocation.
- -p consumer_name
-
Lists all the clients for the specified consumer.
- -r resource_name
-
Lists all the clients that are using the specified resource.
- -t activity_ID
-
Lists the client that has started the specified activities.
client reg -c client_name [-d description] [-t TTL] [-MDS]
Registers the current EGO client with the system so that it can start sending requests to EGO for resources. Following registration, the client may be assigned allocations. The client is assigned a unique identifier such as autoAssignedClient 0 or autoAssignedClient1.
- -c client_name
-
Specifies to register the client with a specific identifier.
Specify a name that is unique within the cluster. Specify up to 40 ASCII characters.
- -d description
-
Specifies a description for the client being registered. This description appears with the information displayed using the client view subcommand. Enclose description in quotation marks if there are spaces within it.
- -t TTL
-
Specifies the client TTL (time to live) in minutes. If the option is not set, default TTL is 900 minutes.
- -MDS
-
Specifies to register the client to use multi-dimensional scheduling.
client rm client_name …
Removes and unregisters the specified client from the system. Use this command to remove a client that is not responding.
- client_name …
-
Specifies the name of the client to be removed.
client unreg
Unregisters the current client from the system. Once this operation completes, the client can no longer request resources from EGO.
After unregistration, all allocations to this client are released.
client view [-MDS] [client_name …]
Displays a list of the registered clients in the cluster, and information about each client, including the host name and port number, the channel, and whether the client is connected.
- client_name …
-
Specifies the name of one or more clients you want to view.
- -MDS
-
Specifies a client that uses multidimensional scheduling.
client whoami
Prints the user name associated with the current client.