Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Run container related commands on a cluster node.
| Command | Description |
|---|---|
| invoke-api | Invoke container API on a container deployed on a Service Fabric node for the given code package. |
| logs | Gets the container logs for container deployed on a Service Fabric node. |
Invoke container API on a container deployed on a Service Fabric node for the given code package.
| Argument | Description |
|---|---|
| --application-id [Required] | The identity of the application. This is typically the full name of the application without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in previous versions. |
| --code-package-instance-id [Required] | ID that uniquely identifies a code package instance deployed on a service fabric node. Can be retrieved by 'service code-package-list'. |
| --code-package-name [Required] | The name of code package specified in service manifest registered as part of an application type in a Service Fabric cluster. |
| --container-api-uri-path [Required] | Container REST API URI path, use '{ID}' in place of container name/id. |
| --node-name [Required] | The name of the node. |
| --service-manifest-name [Required] | The name of a service manifest registered as part of an application type in a Service Fabric cluster. |
| --container-api-body | HTTP request body for container REST API. |
| --container-api-content-type | Content type for container REST API, defaults to 'application/json'. |
| --container-api-http-verb | HTTP verb for container REST API, defaults to GET. |
| --timeout -t | Default: 60. |
| Argument | Description |
|---|---|
| --debug | Increase logging verbosity to show all debug logs. |
| --help -h | Show this help message and exit. |
| --output -o | Output format. Allowed values: json, jsonc, table, tsv. Default: json. |
| --query | JMESPath query string. See http://jmespath.org/ for more information and examples. |
| --verbose | Increase logging verbosity. Use --debug for full debug logs. |
Gets the container logs for container deployed on a Service Fabric node.
| Argument | Description |
|---|---|
| --application-id [Required] | The identity of the application. This is typically the full name of the application without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the application name is "fabric:/myapp/app1", the application identity would be "myapp~app1" in 6.0+ and "myapp/app1" in previous versions. |
| --code-package-instance-id [Required] | Code package instance ID, which can be retrieved by 'service code-package-list'. |
| --code-package-name [Required] | The name of code package specified in service manifest registered as part of an application type in a Service Fabric cluster. |
| --node-name [Required] | The name of the node. |
| --service-manifest-name [Required] | The name of a service manifest registered as part of an application type in a Service Fabric cluster. |
| --tail | Number of lines to show from the end of the logs. Default is 100. 'all' to show the complete logs. |
| --timeout -t | Default: 60. |
| Argument | Description |
|---|---|
| --debug | Increase logging verbosity to show all debug logs. |
| --help -h | Show this help message and exit. |
| --output -o | Output format. Allowed values: json, jsonc, table, tsv. Default: json. |
| --query | JMESPath query string. See http://jmespath.org/ for more information and examples. |
| --verbose | Increase logging verbosity. Use --debug for full debug logs. |
- Set up the Service Fabric CLI.
- Learn how to use the Service Fabric CLI using the sample scripts.