node-instances
The cfy node-instances command is used to view information about the different node-instances of a deployment.
You can use the command to list the node-instances of a specific deployment or of all deployments, and to retrieve information about a single node-instance.
Optional flags
These commands support the common CLI flags.
Commands
list
Usage
cfy node-instances list [OPTIONS]
List node-instances.
If DEPLOYMENT_ID is provided, lists node-instances for that deployment.
Otherwise, lists node-instances for all deployments.
Optional flags
-
-d, --deployment-id TEXT- The unique identifier for the deployment -
-n, --node-name TEXT- The node’s name -
--sort-by TEXT- Key for sorting the list -
--descending- Sort list in descending order [default: False] -
-t, --tenant-name TEXT- The name of the tenant from which to list node-instance. If unspecified, the current tenant is used. This argument cannot be used simultaneously with theall-tenantsargument. -
-a, --all-tenants- Include resources from all tenants associated with the user. This argument cannot be used simultaneously with thetenant-nameargument. -
--search TEXTSearch node-instances by id. The returned list will include only node-instances that contain the given search pattern. -
-o, --pagination-offset INTEGERThe number of resources to skip; –pagination-offset=1 skips the first resource [default: 0] -
-s, --pagination-size INTEGERThe max number of results to retrieve per page [default: 1000]
Example
$ cfy node-instances list
...
Listing all instances...
Node-instances:
+------------------------+------------------------------+-------------+-----------------+---------+------------+----------------+------------+
| id | deployment_id | host_id | node_id | state | visibility | tenant_name | created_by |
+------------------------+------------------------------+-------------+-----------------+---------+------------+----------------+------------+
| host_gkxr6j | cloudify-nodecellar-example | host_gkxr6j | host | started | creator | default_tenant | admin |
| http_web_server_mwtpct | cloudify-hello-world-example | vm_qu2t7i | http_web_server | started | creator | default_tenant | admin |
| mongod_nps479 | cloudify-nodecellar-example | host_gkxr6j | mongod | started | creator | default_tenant | admin |
| nodecellar_gj0mj2 | cloudify-nodecellar-example | host_gkxr6j | nodecellar | started | creator | default_tenant | admin |
| nodejs_gsy2zz | cloudify-nodecellar-example | host_gkxr6j | nodejs | started | creator | default_tenant | admin |
| vm_qu2t7i | cloudify-hello-world-example | vm_qu2t7i | vm | started | creator | default_tenant | admin |
+------------------------+------------------------------+-------------+-----------------+---------+------------+----------------+------------+
...summary
Usage
cfy node-instances summary <field> [optional sub-field] [OPTIONS]
Summarizes node-instances, giving a count of elements with each distinct value for the selected field. If a sub-field is selected then a count will be given for each distinct field and sub-field combination, as well as totals for each field.
For valid field/sub-field names, invoke cfy node-instances summary
Example
$ cfy node-instances summary deployment_id
Retrieving summary of node instances on field deployment_id
Node instance summary by deployment_id
+---------------+----------------+
| deployment_id | node_instances |
+---------------+----------------+
| sga1 | 51 |
| sga3 | 51 |
| sga2 | 51 |
| s3 | 2 |
| s2 | 2 |
| s1 | 2 |
| s5 | 2 |
| s4 | 2 |
| sg1 | 35 |
+---------------+----------------+
...
$ cfy node-instances summary deployment_id state
Retrieving summary of node instances on field deployment_id
Node instance summary by deployment_id
+---------------+---------+----------------+
| deployment_id | state | node_instances |
+---------------+---------+----------------+
| sga1 | started | 51 |
| sga1 | TOTAL | 51 |
| sga3 | started | 51 |
| sga3 | TOTAL | 51 |
| sga2 | started | 51 |
| sga2 | TOTAL | 51 |
| s3 | started | 2 |
| s3 | TOTAL | 2 |
| s2 | started | 2 |
| s2 | TOTAL | 2 |
| s1 | started | 2 |
| s1 | TOTAL | 2 |
| s5 | started | 2 |
| s5 | TOTAL | 2 |
| s4 | started | 2 |
| s4 | TOTAL | 2 |
| sg1 | started | 35 |
| sg1 | TOTAL | 35 |
+---------------+---------+----------------+
...get
Usage
cfy node-instances get [OPTIONS] NODE_INSTANCE_ID
Retrieve information for a specific node-instance.
NODE_INSTANCE_ID is the ID of the node-instance for which to retrieve information.
Optional flags
-t, --tenant-name TEXTThe name of the tenant of the node-instance. If unspecified, the current tenant is used.
Example
$ cfy node-instances get nodecellar_gj0mj2
...
Retrieving node instance nodecellar_gj0mj2
Node-instance:
+-------------------+-----------------------------+-------------+------------+---------+------------+----------------+------------+
| id | deployment_id | host_id | node_id | state | visibility | tenant_name | created_by |
+-------------------+-----------------------------+-------------+------------+---------+------------+----------------+------------+
| nodecellar_gj0mj2 | cloudify-nodecellar-example | host_gkxr6j | nodecellar | started | creator | default_tenant | admin |
+-------------------+-----------------------------+-------------+------------+---------+------------+----------------+------------+
Instance runtime properties:
mongo_port: 27017
nodejs_binaries_path: /tmp/68672f1b-b49a-4e58-ae6f-b2de63676e4f/nodejs/nodejs-binaries
pid: 27816
nodecellar_source_path: /tmp/68672f1b-b49a-4e58-ae6f-b2de63676e4f/nodecellar/nodecellar-source
mongo_ip_address: localhost
...