You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/service-fabric/service-fabric-sfctl-application.md
+6-3Lines changed: 6 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@ description: Learn about sfctl, the Azure Service Fabric command line interface.
4
4
author: jeffj6123
5
5
6
6
ms.topic: reference
7
-
ms.date: 9/17/2019
7
+
ms.date: 1/16/2020
8
8
ms.author: jejarry
9
9
---
10
10
# sfctl application
@@ -524,10 +524,13 @@ Optionally display upload progress for each file in the package. Upload progress
524
524
525
525
|Argument|Description|
526
526
| --- | --- |
527
-
| --path [Required]| Path to local application package. |
527
+
| --path [Required]| Path to local application package. |
528
+
| --compress | Applicable only to Service Fabric application packages. Create a new folder containing the compressed application package to either the default location, or to the location specified by the compressed-location parameter, and then upload the newly created folder. <br><br> If there is already a compressed file generated by sfctl, it will be overwritten if this flag is set. An error will be returned if the directory is not an application package. If it is already a compressed application package, the folder will be copied over as is. By default, the newly created compressed application package will be deleted after a successful upload. If upload is not successful, please manually clean up the compressed package as needed. The deletion does not remove any empty dirs which may have been created if the compressed location parameter references non-existent directories. |
529
+
| --compressed-location | The location to put the compressed application package. <br><br> If no location is provided, the compressed package will be placed under a newly created folder called sfctl_compressed_temp under the parent directory specified in the path argument. For example, if the path argument has value C\:/FolderA/AppPkg, then the compressed package will be added to C\:/FolderA/sfctl_compressed_temp/AppPkg. |
528
530
| --imagestore-string | Destination image store to upload the application package to. Default\: fabric\:ImageStore. <br><br> To upload to a file location, start this parameter with 'file\:'. Otherwise the value should be the image store connection string, such as the default value. |
531
+
| --keep-compressed | Whether or not to keep the generated compressed package on successful upload completion. <br><br> If not set, then on successful completion, the compressed app packages will be deleted. If upload was not successful, then the application package will always be kept in the output directory for re-upload. |
529
532
| --show-progress | Show file upload progress for large packages. |
530
-
| --timeout -t | The total timeout in seconds. Upload will fail and return error after the upload timeout duration has passed. This timeout applies to the entire application package, and individual file timeouts will equal the remaining timeout duration. Default\: 300. |
533
+
| --timeout -t | The total timeout in seconds. Upload will fail and return error after the upload timeout duration has passed. This timeout applies to the entire application package, and individual file timeouts will equal the remaining timeout duration. Timeout does not include the time required to compress the application package. Default\: 300. |
Copy file name to clipboardExpand all lines: articles/service-fabric/service-fabric-sfctl-chaos-schedule.md
+8-4Lines changed: 8 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@ description: Learn about sfctl, the Azure Service Fabric command line interface.
4
4
author: jeffj6123
5
5
6
6
ms.topic: reference
7
-
ms.date: 9/17/2019
7
+
ms.date: 1/16/2020
8
8
ms.author: jejarry
9
9
---
10
10
@@ -67,9 +67,11 @@ Chaos will automatically schedule runs based on the Chaos Schedule. The Chaos Sc
67
67
68
68
### Examples
69
69
70
-
The following command sets a schedule (assuming the current schedule has version 0) that starts on 2016-01-01 and expires on 2038-01-01 that runs Chaos 24 hours of the day, 7 days a week. Chaos will be scheduled on the cluster for that time.
71
-
72
-
sfctl chaos schedule set --version 0 --start-date-utc "2016-01-01T00:00:00.000Z" --expiry-date-utc "2038-01-01T00:00:00.000Z"
70
+
The following command sets a schedule (assuming the current schedule has version 0) that starts
71
+
on 2016-01-01 and expires on 2038-01-01 that runs Chaos 24 hours of the day, 7 days a week.
72
+
Chaos will be scheduled on the cluster for that time.
73
+
```
74
+
sfctl chaos schedule set --version 0 --start-date-utc "2016-01-01T00:00:00.000Z" --expiry-date-utc "2038-01-01T00:00:00.000Z"
73
75
--chaos-parameters-dictionary
74
76
[
75
77
{
@@ -130,6 +132,8 @@ The following command sets a schedule (assuming the current schedule has version
Copy file name to clipboardExpand all lines: articles/service-fabric/service-fabric-sfctl-cluster.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@ description: Learn about sfctl, the Azure Service Fabric command line interface.
4
4
author: jeffj6123
5
5
6
6
ms.topic: reference
7
-
ms.date: 9/17/2019
7
+
ms.date: 1/16/2020
8
8
ms.author: jejarry
9
9
---
10
10
@@ -89,7 +89,7 @@ Use EventsHealthStateFilter to filter the collection of health events reported o
89
89
| --applications-health-state-filter | Allows filtering of the application health state objects returned in the result of cluster health query based on their health state. The possible values for this parameter include integer value obtained from members or bitwise operations on members of HealthStateFilter enumeration. Only applications that match the filter are returned. All applications are used to evaluate the aggregated health state. If not specified, all entries are returned. The state values are flag-based enumeration, so the value could be a combination of these values obtained using bitwise 'OR' operator. For example, if the provided value is 6 then health state of applications with HealthState value of OK (2) and Warning (4) are returned. <br> - Default - Default value. Matches any HealthState. The value is zero. <br> - None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1. <br> - Ok - Filter that matches input with HealthState value Ok. The value is 2. <br> - Warning - Filter that matches input with HealthState value Warning. The value is 4. <br> - Error - Filter that matches input with HealthState value Error. The value is 8. <br> - All - Filter that matches input with any HealthState value. The value is 65535. |
90
90
| --events-health-state-filter | Allows filtering the collection of HealthEvent objects returned based on health state. The possible values for this parameter include integer value of one of the following health states. Only events that match the filter are returned. All events are used to evaluate the aggregated health state. If not specified, all entries are returned. The state values are flag-based enumeration, so the value could be a combination of these values, obtained using the bitwise 'OR' operator. For example, If the provided value is 6 then all of the events with HealthState value of OK (2) and Warning (4) are returned. <br> - Default - Default value. Matches any HealthState. The value is zero. <br> - None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1. <br> - Ok - Filter that matches input with HealthState value Ok. The value is 2. <br> - Warning - Filter that matches input with HealthState value Warning. The value is 4. <br> - Error - Filter that matches input with HealthState value Error. The value is 8. <br> - All - Filter that matches input with any HealthState value. The value is 65535. |
91
91
| --exclude-health-statistics | Indicates whether the health statistics should be returned as part of the query result. False by default. The statistics show the number of children entities in health state Ok, Warning, and Error. |
92
-
| --include-system-application-health-statistics | Indicates whether the health statistics should include the fabric\:/System application health statistics. False by default. If IncludeSystemApplicationHealthStatistics are set to true, the health statistics include the entities that belong to the fabric\:/System application. Otherwise, the query result includes health statistics only for user applications. The health statistics must be included in the query result for this parameter to be applied. |
92
+
| --include-system-application-health-statistics | Indicates whether the health statistics should include the fabric\:/System application health statistics. False by default. If IncludeSystemApplicationHealthStatistics is set to true, the health statistics include the entities that belong to the fabric\:/System application. Otherwise, the query result includes health statistics only for user applications. The health statistics must be included in the query result for this parameter to be applied. |
93
93
| --nodes-health-state-filter | Allows filtering of the node health state objects returned in the result of cluster health query based on their health state. The possible values for this parameter include integer value of one of the following health states. Only nodes that match the filter are returned. All nodes are used to evaluate the aggregated health state. If not specified, all entries are returned. The state values are flag-based enumeration, so the value could be a combination of these values obtained using bitwise 'OR' operator. For example, if the provided value is 6 then health state of nodes with HealthState value of OK (2) and Warning (4) are returned. <br> - Default - Default value. Matches any HealthState. The value is zero. <br> - None - Filter that doesn't match any HealthState value. Used in order to return no results on a given collection of states. The value is 1. <br> - Ok - Filter that matches input with HealthState value Ok. The value is 2. <br> - Warning - Filter that matches input with HealthState value Warning. The value is 4. <br> - Error - Filter that matches input with HealthState value Error. The value is 8. <br> - All - Filter that matches input with any HealthState value. The value is 65535. |
94
94
| --timeout -t | The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. Default\: 60. |
95
95
@@ -156,7 +156,7 @@ Gets the list of user-induced fault operations filtered by provided input.
156
156
157
157
|Argument|Description|
158
158
| --- | --- |
159
-
| --state-filter | Used to filter on OperationState's for user-induced operations. - 65535 - select All - 1 - select Running - 2 - select RollingBack - 8 - select Completed - 16 - select Faulted - 32 - select Canceled - 64 - select ForceCancelled. Default\: 65535. |
159
+
| --state-filter | Used to filter on OperationState's for user-induced operations. - 65535 - select All - 1 - select Running - 2 - select RollingBack - 8 - select Completed - 16 - select Faulted - 32 - select Cancelled - 64 - select ForceCancelled. Default\: 65535. |
160
160
| --timeout -t | The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds. Default\: 60. |
161
161
| --type-filter | Used to filter on OperationType for user-induced operations. - 65535 - select all - 1 - select PartitionDataLoss. - 2 - select PartitionQuorumLoss. - 4 - select PartitionRestart. - 8 - select NodeTransition. Default\: 65535. |
162
162
@@ -231,7 +231,7 @@ Sends a health report on a Service Fabric cluster. The report must contain the i
231
231
| --remove-when-expired | Value that indicates whether the report is removed from health store when it expires. <br><br> If set to true, the report is removed from the health store after it expires. If set to false, the report is treated as an error when expired. The value of this property is false by default. When clients report periodically, they should set RemoveWhenExpired false (default). This way, is the reporter has issues (e.g. deadlock) and can't report, the entity is evaluated at error when the health report expires. This flags the entity as being in Error health state. |
232
232
| --sequence-number | The sequence number for this health report as a numeric string. <br><br> The report sequence number is used by the health store to detect stale reports. If not specified, a sequence number is auto-generated by the health client when a report is added. |
233
233
| --timeout -t | Default\: 60. |
234
-
| --ttl | The duration for which this health report is valid. This field uses ISO8601 format for specifying the duration. <br><br> When clients report periodically, they should send reports with higher frequency than time to live. If clients report on transition, they can set the time too live to infinite. When time to live expires, the health event that contains the health information is either removed from health store, if RemoveWhenExpired is true, or evaluated at error, if RemoveWhenExpired false. If not specified, time to live defaults to infinite value. |
234
+
| --ttl | The duration for which this health report is valid. This field uses ISO8601 format for specifying the duration. <br><br> When clients report periodically, they should send reports with higher frequency than time to live. If clients report on transition, they can set the time to live to infinite. When time to live expires, the health event that contains the health information is either removed from health store, if RemoveWhenExpired is true, or evaluated at error, if RemoveWhenExpired false. If not specified, time to live defaults to infinite value. |
235
235
236
236
### Global Arguments
237
237
@@ -246,7 +246,7 @@ Sends a health report on a Service Fabric cluster. The report must contain the i
246
246
## sfctl cluster select
247
247
Connects to a Service Fabric cluster endpoint.
248
248
249
-
If connecting to secure cluster, specify an absolute path to a cert (.crt) and key file (.key) or a single file with both (.pem). Do not specify both. Optionally, if connecting to a secure cluster, also specify an absolute path to a CA bundle file or directory of trusted CA certs. There is no connection to a cluster without running this command first, including a connection to localhost. However, no explicit endpoint is required for connecting to a local cluster.
249
+
If connecting to secure cluster, specify an absolute path to a cert (.crt) and key file (.key) or a single file with both (.pem). Do not specify both. Optionally, if connecting to a secure cluster, also specify an absolute path to a CA bundle file or directory of trusted CA certs. There is no connection to a cluster without running this command first, including a connection to localhost. However, no explicit endpoint is required for connecting to a local cluster. If using a self signed cert, or other certificate not signed by a well known CA, pass in the --ca parameter to ensure that validation passes. If not on a production cluster, to bypass client side validation (useful for self signed or not well known CA signed), use the --no-verify option. While possible, it is not recommended for production clusters. A certificate verification error may result otherwise.
0 commit comments