netframework/Microsoft.ServiceFabric.Powershell.Http-Help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems xmlns="http://msh" schema="maml"> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-SFClusterManifest</command:name> <command:verb>Get</command:verb> <command:noun>ClusterManifest</command:noun> <maml:description> <maml:para>Get the Service Fabric cluster manifest.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Get the Service Fabric cluster manifest. The cluster manifest contains properties of the cluster that include different node types on the cluster, security configurations, fault, and upgrade domain topologies, etc. These properties are specified as part of the ClusterConfig.JSON file while deploying a stand-alone cluster. However, most of the information in the cluster manifest is generated internally by service fabric during cluster deployment in other deployment scenarios (e.g. when using Azure portal). The contents of the cluster manifest are for informational purposes only and users are not expected to take a dependency on the format of the file contents or its interpretation. </maml:para> </maml:description> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-SFClusterHealth</command:name> <command:verb>Get</command:verb> <command:noun>ClusterHealth</command:noun> <maml:description> <maml:para>Gets the health of a Service Fabric cluster.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Use EventsHealthStateFilter to filter the collection of health events reported on the cluster based on the health state. Similarly, use NodesHealthStateFilter and ApplicationsHealthStateFilter to filter the collection of nodes and applications returned based on their aggregated health state. </maml:para> </maml:description> <command:parameters> <command:parameter required="false" position="0"> <maml:name>NodesHealthStateFilter</maml:name> <maml:Description> <maml:para> 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. - Default - Default value. Matches any HealthState. The value is zero. - 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. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - Error - Filter that matches input with HealthState value Error. The value is 8. - All - Filter that matches input with any HealthState value. The value is 65535. </maml:para> </maml:Description> <command:parameterValue required="false">int?</command:parameterValue> <dev:type> <maml:name>int?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ApplicationsHealthStateFilter</maml:name> <maml:Description> <maml:para> 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. - Default - Default value. Matches any HealthState. The value is zero. - 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. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - Error - Filter that matches input with HealthState value Error. The value is 8. - All - Filter that matches input with any HealthState value. The value is 65535. </maml:para> </maml:Description> <command:parameterValue required="false">int?</command:parameterValue> <dev:type> <maml:name>int?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>EventsHealthStateFilter</maml:name> <maml:Description> <maml:para> 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. - Default - Default value. Matches any HealthState. The value is zero. - 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. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - Error - Filter that matches input with HealthState value Error. The value is 8. - All - Filter that matches input with any HealthState value. The value is 65535. </maml:para> </maml:Description> <command:parameterValue required="false">int?</command:parameterValue> <dev:type> <maml:name>int?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>ExcludeHealthStatistics</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>IncludeSystemApplicationHealthStatistics</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-SFClusterHealthUsingPolicy</command:name> <command:verb>Get</command:verb> <command:noun>ClusterHealthUsingPolicy</command:noun> <maml:description> <maml:para>Gets the health of a Service Fabric cluster using the specified policy.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Use EventsHealthStateFilter to filter the collection of health events reported on the cluster based on the health state. Similarly, use NodesHealthStateFilter and ApplicationsHealthStateFilter to filter the collection of nodes and applications returned based on their aggregated health state. Use ClusterHealthPolicies to override the health policies used to evaluate the health. </maml:para> </maml:description> <command:parameters> <command:parameter required="false" position="0"> <maml:name>NodesHealthStateFilter</maml:name> <maml:Description> <maml:para> 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. - Default - Default value. Matches any HealthState. The value is zero. - 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. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - Error - Filter that matches input with HealthState value Error. The value is 8. - All - Filter that matches input with any HealthState value. The value is 65535. </maml:para> </maml:Description> <command:parameterValue required="false">int?</command:parameterValue> <dev:type> <maml:name>int?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ApplicationsHealthStateFilter</maml:name> <maml:Description> <maml:para> 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. - Default - Default value. Matches any HealthState. The value is zero. - 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. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - Error - Filter that matches input with HealthState value Error. The value is 8. - All - Filter that matches input with any HealthState value. The value is 65535. </maml:para> </maml:Description> <command:parameterValue required="false">int?</command:parameterValue> <dev:type> <maml:name>int?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>EventsHealthStateFilter</maml:name> <maml:Description> <maml:para> 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. - Default - Default value. Matches any HealthState. The value is zero. - 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. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - Error - Filter that matches input with HealthState value Error. The value is 8. - All - Filter that matches input with any HealthState value. The value is 65535. </maml:para> </maml:Description> <command:parameterValue required="false">int?</command:parameterValue> <dev:type> <maml:name>int?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>ExcludeHealthStatistics</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>IncludeSystemApplicationHealthStatistics</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>ApplicationHealthPolicyMap</maml:name> <maml:Description> <maml:para> Defines a map that contains specific application health policies for different applications. Each entry specifies as key the application name and as value an ApplicationHealthPolicy used to evaluate the application health. If an application is not specified in the map, the application health evaluation uses the ApplicationHealthPolicy found in its application manifest or the default application health policy (if no health policy is defined in the manifest). The map is empty by default. </maml:para> </maml:Description> <command:parameterValue required="false">IEnumerable<ApplicationHealthPolicyMapItem></command:parameterValue> <dev:type> <maml:name>IEnumerable<ApplicationHealthPolicyMapItem></maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>ConsiderWarningAsError</maml:name> <maml:Description> <maml:para> Indicates whether warnings are treated with the same severity as errors. </maml:para> </maml:Description> <command:parameterValue required="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>MaxPercentUnhealthyNodes</maml:name> <maml:Description> <maml:para> The maximum allowed percentage of unhealthy nodes before reporting an error. For example, to allow 10% of nodes to be unhealthy, this value would be 10. The percentage represents the maximum tolerated percentage of nodes that can be unhealthy before the cluster is considered in error. If the percentage is respected but there is at least one unhealthy node, the health is evaluated as Warning. The percentage is calculated by dividing the number of unhealthy nodes over the total number of nodes in the cluster. The computation rounds up to tolerate one failure on small numbers of nodes. Default percentage is zero. In large clusters, some nodes will always be down or out for repairs, so this percentage should be configured to tolerate that. </maml:para> </maml:Description> <command:parameterValue required="false">int?</command:parameterValue> <dev:type> <maml:name>int?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>MaxPercentUnhealthyApplications</maml:name> <maml:Description> <maml:para> The maximum allowed percentage of unhealthy applications before reporting an error. For example, to allow 10% of applications to be unhealthy, this value would be 10. The percentage represents the maximum tolerated percentage of applications that can be unhealthy before the cluster is considered in error. If the percentage is respected but there is at least one unhealthy application, the health is evaluated as Warning. This is calculated by dividing the number of unhealthy applications over the total number of application instances in the cluster, excluding applications of application types that are included in the ApplicationTypeHealthPolicyMap. The computation rounds up to tolerate one failure on small numbers of applications. Default percentage is zero. </maml:para> </maml:Description> <command:parameterValue required="false">int?</command:parameterValue> <dev:type> <maml:name>int?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>ApplicationTypeHealthPolicyMap</maml:name> <maml:Description> <maml:para> Defines a map with max percentage unhealthy applications for specific application types. Each entry specifies as key the application type name and as value an integer that represents the MaxPercentUnhealthyApplications percentage used to evaluate the applications of the specified application type. The application type health policy map can be used during cluster health evaluation to describe special application types. The application types included in the map are evaluated against the percentage specified in the map, and not with the global MaxPercentUnhealthyApplications defined in the cluster health policy. The applications of application types specified in the map are not counted against the global pool of applications. For example, if some applications of a type are critical, the cluster administrator can add an entry to the map for that application type and assign it a value of 0% (that is, do not tolerate any failures). All other applications can be evaluated with MaxPercentUnhealthyApplications set to 20% to tolerate some failures out of the thousands of application instances. The application type health policy map is used only if the cluster manifest enables application type health evaluation using the configuration entry for HealthManager/EnableApplicationTypeHealthEvaluation. </maml:para> </maml:Description> <command:parameterValue required="false">IEnumerable<ApplicationTypeHealthPolicyMapItem></command:parameterValue> <dev:type> <maml:name>IEnumerable<ApplicationTypeHealthPolicyMapItem></maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-SFClusterHealthChunk</command:name> <command:verb>Get</command:verb> <command:noun>ClusterHealthChunk</command:noun> <maml:description> <maml:para>Gets the health of a Service Fabric cluster using health chunks.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Gets the health of a Service Fabric cluster using health chunks. Includes the aggregated health state of the cluster, but none of the cluster entities. To expand the cluster health and get the health state of all or some of the entities, use the POST URI and specify the cluster health chunk query description. </maml:para> </maml:description> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-SFClusterHealthChunkUsingPolicyAndAdvancedFilters</command:name> <command:verb>Get</command:verb> <command:noun>ClusterHealthChunkUsingPolicyAndAdvancedFilters</command:noun> <maml:description> <maml:para>Gets the health of a Service Fabric cluster using health chunks.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Gets the health of a Service Fabric cluster using health chunks. The health evaluation is done based on the input cluster health chunk query description. The query description allows users to specify health policies for evaluating the cluster and its children. Users can specify very flexible filters to select which cluster entities to return. The selection can be done based on the entities health state and based on the hierarchy. The query can return multi-level children of the entities based on the specified filters. For example, it can return one application with a specified name, and for this application, return only services that are in Error or Warning, and all partitions and replicas for one of these services. </maml:para> </maml:description> <command:parameters> <command:parameter required="false" position="0"> <maml:name>NodeFilters</maml:name> <maml:Description> <maml:para> Defines a list of filters that specify which nodes to be included in the returned cluster health chunk. If no filters are specified, no nodes are returned. All the nodes are used to evaluate the cluster's aggregated health state, regardless of the input filters. The cluster health chunk query may specify multiple node filters. For example, it can specify a filter to return all nodes with health state Error and another filter to always include a node identified by its NodeName. </maml:para> </maml:Description> <command:parameterValue required="false">IEnumerable<NodeHealthStateFilter></command:parameterValue> <dev:type> <maml:name>IEnumerable<NodeHealthStateFilter></maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ApplicationFilters</maml:name> <maml:Description> <maml:para> Defines a list of filters that specify which applications to be included in the returned cluster health chunk. If no filters are specified, no applications are returned. All the applications are used to evaluate the cluster's aggregated health state, regardless of the input filters. The cluster health chunk query may specify multiple application filters. For example, it can specify a filter to return all applications with health state Error and another filter to always include applications of a specified application type. </maml:para> </maml:Description> <command:parameterValue required="false">IEnumerable<ApplicationHealthStateFilter></command:parameterValue> <dev:type> <maml:name>IEnumerable<ApplicationHealthStateFilter></maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ConsiderWarningAsError</maml:name> <maml:Description> <maml:para> Indicates whether warnings are treated with the same severity as errors. </maml:para> </maml:Description> <command:parameterValue required="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>MaxPercentUnhealthyNodes</maml:name> <maml:Description> <maml:para> The maximum allowed percentage of unhealthy nodes before reporting an error. For example, to allow 10% of nodes to be unhealthy, this value would be 10. The percentage represents the maximum tolerated percentage of nodes that can be unhealthy before the cluster is considered in error. If the percentage is respected but there is at least one unhealthy node, the health is evaluated as Warning. The percentage is calculated by dividing the number of unhealthy nodes over the total number of nodes in the cluster. The computation rounds up to tolerate one failure on small numbers of nodes. Default percentage is zero. In large clusters, some nodes will always be down or out for repairs, so this percentage should be configured to tolerate that. </maml:para> </maml:Description> <command:parameterValue required="false">int?</command:parameterValue> <dev:type> <maml:name>int?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>MaxPercentUnhealthyApplications</maml:name> <maml:Description> <maml:para> The maximum allowed percentage of unhealthy applications before reporting an error. For example, to allow 10% of applications to be unhealthy, this value would be 10. The percentage represents the maximum tolerated percentage of applications that can be unhealthy before the cluster is considered in error. If the percentage is respected but there is at least one unhealthy application, the health is evaluated as Warning. This is calculated by dividing the number of unhealthy applications over the total number of application instances in the cluster, excluding applications of application types that are included in the ApplicationTypeHealthPolicyMap. The computation rounds up to tolerate one failure on small numbers of applications. Default percentage is zero. </maml:para> </maml:Description> <command:parameterValue required="false">int?</command:parameterValue> <dev:type> <maml:name>int?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>ApplicationTypeHealthPolicyMap</maml:name> <maml:Description> <maml:para> Defines a map with max percentage unhealthy applications for specific application types. Each entry specifies as key the application type name and as value an integer that represents the MaxPercentUnhealthyApplications percentage used to evaluate the applications of the specified application type. The application type health policy map can be used during cluster health evaluation to describe special application types. The application types included in the map are evaluated against the percentage specified in the map, and not with the global MaxPercentUnhealthyApplications defined in the cluster health policy. The applications of application types specified in the map are not counted against the global pool of applications. For example, if some applications of a type are critical, the cluster administrator can add an entry to the map for that application type and assign it a value of 0% (that is, do not tolerate any failures). All other applications can be evaluated with MaxPercentUnhealthyApplications set to 20% to tolerate some failures out of the thousands of application instances. The application type health policy map is used only if the cluster manifest enables application type health evaluation using the configuration entry for HealthManager/EnableApplicationTypeHealthEvaluation. </maml:para> </maml:Description> <command:parameterValue required="false">IEnumerable<ApplicationTypeHealthPolicyMapItem></command:parameterValue> <dev:type> <maml:name>IEnumerable<ApplicationTypeHealthPolicyMapItem></maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>ApplicationHealthPolicyMap</maml:name> <maml:Description> <maml:para> The wrapper that contains the map with application health policies used to evaluate specific applications in the cluster. </maml:para> </maml:Description> <command:parameterValue required="false">IEnumerable<ApplicationHealthPolicyMapItem></command:parameterValue> <dev:type> <maml:name>IEnumerable<ApplicationHealthPolicyMapItem></maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-SFClusterHealth</command:name> <command:verb>New</command:verb> <command:noun>ClusterHealth</command:noun> <maml:description> <maml:para>Sends a health report on the Service Fabric cluster.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Sends a health report on a Service Fabric cluster. The report must contain the information about the source of the health report and property on which it is reported. The report is sent to a Service Fabric gateway node, which forwards to the health store. The report may be accepted by the gateway, but rejected by the health store after extra validation. For example, the health store may reject the report because of an invalid parameter, like a stale sequence number. To see whether the report was applied in the health store, run GetClusterHealth and check that the report appears in the HealthEvents section. </maml:para> </maml:description> <command:parameters> <command:parameter required="true" position="0"> <maml:name>SourceId</maml:name> <maml:Description> <maml:para> The source name that identifies the client/watchdog/system component that generated the health information. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Property</maml:name> <maml:Description> <maml:para> The property of the health information. An entity can have health reports for different properties. The property is a string and not a fixed enumeration to allow the reporter flexibility to categorize the state condition that triggers the report. For example, a reporter with SourceId "LocalWatchdog" can monitor the state of the available disk on a node, so it can report "AvailableDisk" property on that node. The same reporter can monitor the node connectivity, so it can report a property "Connectivity" on the same node. In the health store, these reports are treated as separate health events for the specified node. Together with the SourceId, the property uniquely identifies the health information. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>HealthState</maml:name> <maml:Description> <maml:para> The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown' </maml:para> </maml:Description> <command:parameterValue required="true">HealthState?</command:parameterValue> <dev:type> <maml:name>HealthState?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>TimeToLiveInMilliSeconds</maml:name> <maml:Description> <maml:para> The duration for which this health report is valid. This field uses ISO8601 format for specifying the duration. 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. </maml:para> </maml:Description> <command:parameterValue required="false">TimeSpan?</command:parameterValue> <dev:type> <maml:name>TimeSpan?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Description</maml:name> <maml:Description> <maml:para> The description of the health information. It represents free text used to add human readable information about the report. The maximum string length for the description is 4096 characters. If the provided string is longer, it will be automatically truncated. When truncated, the last characters of the description contain a marker "[Truncated]", and total string size is 4096 characters. The presence of the marker indicates to users that truncation occurred. Note that when truncated, the description has less than 4096 characters from the original string. </maml:para> </maml:Description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SequenceNumber</maml:name> <maml:Description> <maml:para> The sequence number for this health report as a numeric string. 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. </maml:para> </maml:Description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>RemoveWhenExpired</maml:name> <maml:Description> <maml:para> Value that indicates whether the report is removed from health store when it expires. 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, if 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. </maml:para> </maml:Description> <command:parameterValue required="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Immediate</maml:name> <maml:Description> <maml:para> A flag that indicates whether the report should be sent immediately. A health report is sent to a Service Fabric gateway Application, which forwards to the health store. If Immediate is set to true, the report is sent immediately from HTTP Gateway to the health store, regardless of the fabric client settings that the HTTP Gateway Application is using. This is useful for critical reports that should be sent as soon as possible. Depending on timing and other conditions, sending the report may still fail, for example if the HTTP Gateway is closed or the message doesn't reach the Gateway. If Immediate is set to false, the report is sent based on the health client settings from the HTTP Gateway. Therefore, it will be batched according to the HealthReportSendInterval configuration. This is the recommended setting because it allows the health client to optimize health reporting messages to health store as well as health report processing. By default, reports are not sent immediately. </maml:para> </maml:Description> <command:parameterValue required="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-SFProvisionedFabricCodeVersionInfoList</command:name> <command:verb>Get</command:verb> <command:noun>ProvisionedFabricCodeVersionInfoList</command:noun> <maml:description> <maml:para>Gets a list of fabric code versions that are provisioned in a Service Fabric cluster.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Gets a list of information about fabric code versions that are provisioned in the cluster. The parameter CodeVersion can be used to optionally filter the output to only that particular version.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" position="0"> <maml:name>CodeVersion</maml:name> <maml:Description> <maml:para> The product version of Service Fabric. </maml:para> </maml:Description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-SFProvisionedFabricConfigVersionInfoList</command:name> <command:verb>Get</command:verb> <command:noun>ProvisionedFabricConfigVersionInfoList</command:noun> <maml:description> <maml:para>Gets a list of fabric config versions that are provisioned in a Service Fabric cluster.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Gets a list of information about fabric config versions that are provisioned in the cluster. The parameter ConfigVersion can be used to optionally filter the output to only that particular version.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ConfigVersion</maml:name> <maml:Description> <maml:para> The config version of Service Fabric. </maml:para> </maml:Description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-SFClusterUpgradeProgress</command:name> <command:verb>Get</command:verb> <command:noun>ClusterUpgradeProgress</command:noun> <maml:description> <maml:para>Gets the progress of the current cluster upgrade.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Gets the current progress of the ongoing cluster upgrade. If no upgrade is currently in progress, get the last state of the previous cluster upgrade.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-SFClusterConfiguration</command:name> <command:verb>Get</command:verb> <command:noun>ClusterConfiguration</command:noun> <maml:description> <maml:para>Get the Service Fabric standalone cluster configuration.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>The cluster configuration contains properties of the cluster that include different node types on the cluster, security configurations, fault, and upgrade domain topologies, etc. </maml:para> </maml:description> <command:parameters> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="0"> <maml:name>ConfigurationApiVersion</maml:name> <maml:Description> <maml:para> The API version of the Standalone cluster json configuration. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-SFClusterConfigurationUpgradeStatus</command:name> <command:verb>Get</command:verb> <command:noun>ClusterConfigurationUpgradeStatus</command:noun> <maml:description> <maml:para>Get the cluster configuration upgrade status of a Service Fabric standalone cluster.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Get the cluster configuration upgrade status details of a Service Fabric standalone cluster. </maml:para> </maml:description> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-SFUpgradeOrchestrationServiceState</command:name> <command:verb>Get</command:verb> <command:noun>UpgradeOrchestrationServiceState</command:noun> <maml:description> <maml:para>Get the service state of Service Fabric Upgrade Orchestration Service.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Get the service state of Service Fabric Upgrade Orchestration Service. This API is internally used for support purposes.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-SFUpgradeOrchestrationServiceState</command:name> <command:verb>Set</command:verb> <command:noun>UpgradeOrchestrationServiceState</command:noun> <maml:description> <maml:para>Update the service state of Service Fabric Upgrade Orchestration Service.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Update the service state of Service Fabric Upgrade Orchestration Service. This API is internally used for support purposes.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ServiceState</maml:name> <maml:Description> <maml:para> The state of Service Fabric Upgrade Orchestration Service. </maml:para> </maml:Description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Register-SFCluster</command:name> <command:verb>Register</command:verb> <command:noun>Cluster</command:noun> <maml:description> <maml:para>Provision the code or configuration packages of a Service Fabric cluster.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Validate and provision the code or configuration packages of a Service Fabric cluster.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" position="0"> <maml:name>CodeFilePath</maml:name> <maml:Description> <maml:para> The cluster code package file path. </maml:para> </maml:Description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ClusterManifestFilePath</maml:name> <maml:Description> <maml:para> The cluster manifest file path. </maml:para> </maml:Description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Unregister-SFCluster</command:name> <command:verb>Unregister</command:verb> <command:noun>Cluster</command:noun> <maml:description> <maml:para>Unprovision the code or configuration packages of a Service Fabric cluster.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>It is supported to unprovision code and configuration separately.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" position="0"> <maml:name>CodeVersion</maml:name> <maml:Description> <maml:para> The cluster code package version. </maml:para> </maml:Description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ConfigVersion</maml:name> <maml:Description> <maml:para> The cluster manifest version. </maml:para> </maml:Description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-SFClusterUpgrade</command:name> <command:verb>New</command:verb> <command:noun>ClusterUpgrade</command:noun> <maml:description> <maml:para>Roll back the upgrade of a Service Fabric cluster.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Roll back the code or configuration upgrade of a Service Fabric cluster.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Resume-SFClusterUpgrade</command:name> <command:verb>Resume</command:verb> <command:noun>ClusterUpgrade</command:noun> <maml:description> <maml:para>Make the cluster upgrade move on to the next upgrade domain.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Make the cluster code or configuration upgrade move on to the next upgrade domain if appropriate.</maml:para> </maml:description> <command:parameters> <command:parameter required="true" position="0"> <maml:name>UpgradeDomain</maml:name> <maml:Description> <maml:para> The next upgrade domain for this cluster upgrade. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Start-SFClusterUpgrade</command:name> <command:verb>Start</command:verb> <command:noun>ClusterUpgrade</command:noun> <maml:description> <maml:para>Start upgrading the code or configuration version of a Service Fabric cluster.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Validate the supplied upgrade parameters and start upgrading the code or configuration version of a Service Fabric cluster if the parameters are valid.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" position="0"> <maml:name>CodeVersion</maml:name> <maml:Description> <maml:para> The cluster code version. </maml:para> </maml:Description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ConfigVersion</maml:name> <maml:Description> <maml:para> The cluster configuration version. </maml:para> </maml:Description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>UpgradeKind</maml:name> <maml:Description> <maml:para> The kind of upgrade out of the following possible values. Possible values include: 'Invalid', 'Rolling' </maml:para> </maml:Description> <command:parameterValue required="false">UpgradeKind?</command:parameterValue> <dev:type> <maml:name>UpgradeKind?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>RollingUpgradeMode</maml:name> <maml:Description> <maml:para> The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, and Monitored. Possible values include: 'Invalid', 'UnmonitoredAuto', 'UnmonitoredManual', 'Monitored' </maml:para> </maml:Description> <command:parameterValue required="false">UpgradeMode?</command:parameterValue> <dev:type> <maml:name>UpgradeMode?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>UpgradeReplicaSetCheckTimeoutInSeconds</maml:name> <maml:Description> <maml:para> The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. Valid values are between 0 and 42949672925 inclusive. (unsigned 32-bit integer). </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>ForceRestart</maml:name> <maml:Description> <maml:para> If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data). </maml:para> </maml:Description> <command:parameterValue required="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>SortOrder</maml:name> <maml:Description> <maml:para> Defines the order in which an upgrade proceeds through the cluster. Possible values include: 'Invalid', 'Default', 'Numeric', 'Lexicographical', 'ReverseNumeric', 'ReverseLexicographical' </maml:para> </maml:Description> <command:parameterValue required="false">UpgradeSortOrder?</command:parameterValue> <dev:type> <maml:name>UpgradeSortOrder?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>FailureAction</maml:name> <maml:Description> <maml:para> The compensating action to perform when a Monitored upgrade encounters monitoring policy or health policy violations. Invalid indicates the failure action is invalid. Rollback specifies that the upgrade will start rolling back automatically. Manual indicates that the upgrade will switch to UnmonitoredManual upgrade mode. . Possible values include: 'Invalid', 'Rollback', 'Manual' </maml:para> </maml:Description> <command:parameterValue required="false">FailureAction?</command:parameterValue> <dev:type> <maml:name>FailureAction?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>HealthCheckWaitDurationInMilliseconds</maml:name> <maml:Description> <maml:para> The amount of time to wait after completing an upgrade domain before applying health policies. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds. </maml:para> </maml:Description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>HealthCheckStableDurationInMilliseconds</maml:name> <maml:Description> <maml:para> The amount of time that the application or cluster must remain healthy before the upgrade proceeds to the next upgrade domain. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds. </maml:para> </maml:Description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>HealthCheckRetryTimeoutInMilliseconds</maml:name> <maml:Description> <maml:para> The amount of time to retry health evaluation when the application or cluster is unhealthy before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds. </maml:para> </maml:Description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>UpgradeTimeoutInMilliseconds</maml:name> <maml:Description> <maml:para> The amount of time the overall upgrade has to complete before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds. </maml:para> </maml:Description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>UpgradeDomainTimeoutInMilliseconds</maml:name> <maml:Description> <maml:para> The amount of time each upgrade domain has to complete before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds. </maml:para> </maml:Description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>ConsiderWarningAsError</maml:name> <maml:Description> <maml:para> Indicates whether warnings are treated with the same severity as errors. </maml:para> </maml:Description> <command:parameterValue required="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>MaxPercentUnhealthyNodes</maml:name> <maml:Description> <maml:para> The maximum allowed percentage of unhealthy nodes before reporting an error. For example, to allow 10% of nodes to be unhealthy, this value would be 10. The percentage represents the maximum tolerated percentage of nodes that can be unhealthy before the cluster is considered in error. If the percentage is respected but there is at least one unhealthy node, the health is evaluated as Warning. The percentage is calculated by dividing the number of unhealthy nodes over the total number of nodes in the cluster. The computation rounds up to tolerate one failure on small numbers of nodes. Default percentage is zero. In large clusters, some nodes will always be down or out for repairs, so this percentage should be configured to tolerate that. </maml:para> </maml:Description> <command:parameterValue required="false">int?</command:parameterValue> <dev:type> <maml:name>int?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>MaxPercentUnhealthyApplications</maml:name> <maml:Description> <maml:para> The maximum allowed percentage of unhealthy applications before reporting an error. For example, to allow 10% of applications to be unhealthy, this value would be 10. The percentage represents the maximum tolerated percentage of applications that can be unhealthy before the cluster is considered in error. If the percentage is respected but there is at least one unhealthy application, the health is evaluated as Warning. This is calculated by dividing the number of unhealthy applications over the total number of application instances in the cluster, excluding applications of application types that are included in the ApplicationTypeHealthPolicyMap. The computation rounds up to tolerate one failure on small numbers of applications. Default percentage is zero. </maml:para> </maml:Description> <command:parameterValue required="false">int?</command:parameterValue> <dev:type> <maml:name>int?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>ApplicationTypeHealthPolicyMap</maml:name> <maml:Description> <maml:para> Defines a map with max percentage unhealthy applications for specific application types. Each entry specifies as key the application type name and as value an integer that represents the MaxPercentUnhealthyApplications percentage used to evaluate the applications of the specified application type. The application type health policy map can be used during cluster health evaluation to describe special application types. The application types included in the map are evaluated against the percentage specified in the map, and not with the global MaxPercentUnhealthyApplications defined in the cluster health policy. The applications of application types specified in the map are not counted against the global pool of applications. For example, if some applications of a type are critical, the cluster administrator can add an entry to the map for that application type and assign it a value of 0% (that is, do not tolerate any failures). All other applications can be evaluated with MaxPercentUnhealthyApplications set to 20% to tolerate some failures out of the thousands of application instances. The application type health policy map is used only if the cluster manifest enables application type health evaluation using the configuration entry for HealthManager/EnableApplicationTypeHealthEvaluation. </maml:para> </maml:Description> <command:parameterValue required="false">IEnumerable<ApplicationTypeHealthPolicyMapItem></command:parameterValue> <dev:type> <maml:name>IEnumerable<ApplicationTypeHealthPolicyMapItem></maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>EnableDeltaHealthEvaluation</maml:name> <maml:Description> <maml:para> When true, enables delta health evaluation rather than absolute health evaluation after completion of each upgrade domain. </maml:para> </maml:Description> <command:parameterValue required="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>MaxPercentDeltaUnhealthyNodes</maml:name> <maml:Description> <maml:para> The maximum allowed percentage of nodes health degradation allowed during cluster upgrades. The delta is measured between the state of the nodes at the beginning of upgrade and the state of the nodes at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion to make sure the global state of the cluster is within tolerated limits. The default value is 10%. </maml:para> </maml:Description> <command:parameterValue required="false">int?</command:parameterValue> <dev:type> <maml:name>int?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>MaxPercentUpgradeDomainDeltaUnhealthyNodes</maml:name> <maml:Description> <maml:para> The maximum allowed percentage of upgrade domain nodes health degradation allowed during cluster upgrades. The delta is measured between the state of the upgrade domain nodes at the beginning of upgrade and the state of the upgrade domain nodes at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion for all completed upgrade domains to make sure the state of the upgrade domains is within tolerated limits. The default value is 15%. </maml:para> </maml:Description> <command:parameterValue required="false">int?</command:parameterValue> <dev:type> <maml:name>int?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>ApplicationHealthPolicyMap</maml:name> <maml:Description> <maml:para> The wrapper that contains the map with application health policies used to evaluate specific applications in the cluster. </maml:para> </maml:Description> <command:parameterValue required="false">IEnumerable<ApplicationHealthPolicyMapItem></command:parameterValue> <dev:type> <maml:name>IEnumerable<ApplicationHealthPolicyMapItem></maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Start-SFClusterConfigurationUpgrade</command:name> <command:verb>Start</command:verb> <command:noun>ClusterConfigurationUpgrade</command:noun> <maml:description> <maml:para>Start upgrading the configuration of a Service Fabric standalone cluster.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Validate the supplied configuration upgrade parameters and start upgrading the cluster configuration if the parameters are valid.</maml:para> </maml:description> <command:parameters> <command:parameter required="true" position="0"> <maml:name>ClusterConfig</maml:name> <maml:Description> <maml:para> The cluster configuration as a JSON string. For example, [this file](https://github.com/Azure-Samples/service-fabric-dotnet-standalone-cluster-configuration/blob/master/Samples/ClusterConfig.Unsecure.DevCluster.json) contains JSON describing the [nodes and other properties of the cluster](https://docs.microsoft.com/azure/service-fabric/service-fabric-cluster-manifest). </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>HealthCheckRetryTimeout</maml:name> <maml:Description> <maml:para> The length of time between attempts to perform health checks if the application or cluster is not healthy. </maml:para> </maml:Description> <command:parameterValue required="false">TimeSpan?</command:parameterValue> <dev:type> <maml:name>TimeSpan?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>HealthCheckWaitDurationInSeconds</maml:name> <maml:Description> <maml:para> The length of time to wait after completing an upgrade domain before starting the health checks process. </maml:para> </maml:Description> <command:parameterValue required="false">TimeSpan?</command:parameterValue> <dev:type> <maml:name>TimeSpan?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>HealthCheckStableDurationInSeconds</maml:name> <maml:Description> <maml:para> The length of time that the application or cluster must remain healthy before the upgrade proceeds to the next upgrade domain. </maml:para> </maml:Description> <command:parameterValue required="false">TimeSpan?</command:parameterValue> <dev:type> <maml:name>TimeSpan?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>UpgradeDomainTimeoutInSeconds</maml:name> <maml:Description> <maml:para> The timeout for the upgrade domain. </maml:para> </maml:Description> <command:parameterValue required="false">TimeSpan?</command:parameterValue> <dev:type> <maml:name>TimeSpan?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>UpgradeTimeoutInSeconds</maml:name> <maml:Description> <maml:para> The upgrade timeout. </maml:para> </maml:Description> <command:parameterValue required="false">TimeSpan?</command:parameterValue> <dev:type> <maml:name>TimeSpan?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>MaxPercentUnhealthyApplications</maml:name> <maml:Description> <maml:para> The maximum allowed percentage of unhealthy applications during the upgrade. Allowed values are integer values from zero to 100. </maml:para> </maml:Description> <command:parameterValue required="false">int?</command:parameterValue> <dev:type> <maml:name>int?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>MaxPercentUnhealthyNodes</maml:name> <maml:Description> <maml:para> The maximum allowed percentage of unhealthy nodes during the upgrade. Allowed values are integer values from zero to 100. </maml:para> </maml:Description> <command:parameterValue required="false">int?</command:parameterValue> <dev:type> <maml:name>int?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>MaxPercentDeltaUnhealthyNodes</maml:name> <maml:Description> <maml:para> The maximum allowed percentage of delta health degradation during the upgrade. Allowed values are integer values from zero to 100. </maml:para> </maml:Description> <command:parameterValue required="false">int?</command:parameterValue> <dev:type> <maml:name>int?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>MaxPercentUpgradeDomainDeltaUnhealthyNodes</maml:name> <maml:Description> <maml:para> The maximum allowed percentage of upgrade domain delta health degradation during the upgrade. Allowed values are integer values from zero to 100. </maml:para> </maml:Description> <command:parameterValue required="false">int?</command:parameterValue> <dev:type> <maml:name>int?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>ApplicationHealthPolicyMap</maml:name> <maml:Description> <maml:para> The wrapper that contains the map with application health policies used to evaluate specific applications in the cluster. </maml:para> </maml:Description> <command:parameterValue required="false">IEnumerable<ApplicationHealthPolicyMapItem></command:parameterValue> <dev:type> <maml:name>IEnumerable<ApplicationHealthPolicyMapItem></maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Update-SFClusterUpgrade</command:name> <command:verb>Update</command:verb> <command:noun>ClusterUpgrade</command:noun> <maml:description> <maml:para>Update the upgrade parameters of a Service Fabric cluster upgrade.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Update the upgrade parameters used during a Service Fabric cluster upgrade.</maml:para> </maml:description> <command:parameters> <command:parameter required="true" position="0"> <maml:name>RollingUpgradeMode</maml:name> <maml:Description> <maml:para> The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, and Monitored. Possible values include: 'Invalid', 'UnmonitoredAuto', 'UnmonitoredManual', 'Monitored' </maml:para> </maml:Description> <command:parameterValue required="true">UpgradeMode?</command:parameterValue> <dev:type> <maml:name>UpgradeMode?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>UpgradeKind</maml:name> <maml:Description> <maml:para> The type of upgrade out of the following possible values. Possible values include: 'Invalid', 'Rolling', 'Rolling_ForceRestart' </maml:para> </maml:Description> <command:parameterValue required="false">UpgradeType?</command:parameterValue> <dev:type> <maml:name>UpgradeType?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ForceRestart</maml:name> <maml:Description> <maml:para> If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data). </maml:para> </maml:Description> <command:parameterValue required="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>ReplicaSetCheckTimeoutInMilliseconds</maml:name> <maml:Description> <maml:para> The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. Valid values are between 0 and 42949672925 inclusive. (unsigned 32-bit integer). </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>FailureAction</maml:name> <maml:Description> <maml:para> The compensating action to perform when a Monitored upgrade encounters monitoring policy or health policy violations. Invalid indicates the failure action is invalid. Rollback specifies that the upgrade will start rolling back automatically. Manual indicates that the upgrade will switch to UnmonitoredManual upgrade mode. . Possible values include: 'Invalid', 'Rollback', 'Manual' </maml:para> </maml:Description> <command:parameterValue required="false">FailureAction?</command:parameterValue> <dev:type> <maml:name>FailureAction?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>HealthCheckWaitDurationInMilliseconds</maml:name> <maml:Description> <maml:para> The amount of time to wait after completing an upgrade domain before applying health policies. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds. </maml:para> </maml:Description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>HealthCheckStableDurationInMilliseconds</maml:name> <maml:Description> <maml:para> The amount of time that the application or cluster must remain healthy before the upgrade proceeds to the next upgrade domain. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds. </maml:para> </maml:Description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>HealthCheckRetryTimeoutInMilliseconds</maml:name> <maml:Description> <maml:para> The amount of time to retry health evaluation when the application or cluster is unhealthy before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds. </maml:para> </maml:Description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>UpgradeTimeoutInMilliseconds</maml:name> <maml:Description> <maml:para> The amount of time the overall upgrade has to complete before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds. </maml:para> </maml:Description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>UpgradeDomainTimeoutInMilliseconds</maml:name> <maml:Description> <maml:para> The amount of time each upgrade domain has to complete before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds. </maml:para> </maml:Description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>ConsiderWarningAsError</maml:name> <maml:Description> <maml:para> Indicates whether warnings are treated with the same severity as errors. </maml:para> </maml:Description> <command:parameterValue required="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>MaxPercentUnhealthyNodes</maml:name> <maml:Description> <maml:para> The maximum allowed percentage of unhealthy nodes before reporting an error. For example, to allow 10% of nodes to be unhealthy, this value would be 10. The percentage represents the maximum tolerated percentage of nodes that can be unhealthy before the cluster is considered in error. If the percentage is respected but there is at least one unhealthy node, the health is evaluated as Warning. The percentage is calculated by dividing the number of unhealthy nodes over the total number of nodes in the cluster. The computation rounds up to tolerate one failure on small numbers of nodes. Default percentage is zero. In large clusters, some nodes will always be down or out for repairs, so this percentage should be configured to tolerate that. </maml:para> </maml:Description> <command:parameterValue required="false">int?</command:parameterValue> <dev:type> <maml:name>int?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>MaxPercentUnhealthyApplications</maml:name> <maml:Description> <maml:para> The maximum allowed percentage of unhealthy applications before reporting an error. For example, to allow 10% of applications to be unhealthy, this value would be 10. The percentage represents the maximum tolerated percentage of applications that can be unhealthy before the cluster is considered in error. If the percentage is respected but there is at least one unhealthy application, the health is evaluated as Warning. This is calculated by dividing the number of unhealthy applications over the total number of application instances in the cluster, excluding applications of application types that are included in the ApplicationTypeHealthPolicyMap. The computation rounds up to tolerate one failure on small numbers of applications. Default percentage is zero. </maml:para> </maml:Description> <command:parameterValue required="false">int?</command:parameterValue> <dev:type> <maml:name>int?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>ApplicationTypeHealthPolicyMap</maml:name> <maml:Description> <maml:para> Defines a map with max percentage unhealthy applications for specific application types. Each entry specifies as key the application type name and as value an integer that represents the MaxPercentUnhealthyApplications percentage used to evaluate the applications of the specified application type. The application type health policy map can be used during cluster health evaluation to describe special application types. The application types included in the map are evaluated against the percentage specified in the map, and not with the global MaxPercentUnhealthyApplications defined in the cluster health policy. The applications of application types specified in the map are not counted against the global pool of applications. For example, if some applications of a type are critical, the cluster administrator can add an entry to the map for that application type and assign it a value of 0% (that is, do not tolerate any failures). All other applications can be evaluated with MaxPercentUnhealthyApplications set to 20% to tolerate some failures out of the thousands of application instances. The application type health policy map is used only if the cluster manifest enables application type health evaluation using the configuration entry for HealthManager/EnableApplicationTypeHealthEvaluation. </maml:para> </maml:Description> <command:parameterValue required="false">IEnumerable<ApplicationTypeHealthPolicyMapItem></command:parameterValue> <dev:type> <maml:name>IEnumerable<ApplicationTypeHealthPolicyMapItem></maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>EnableDeltaHealthEvaluation</maml:name> <maml:Description> <maml:para> When true, enables delta health evaluation rather than absolute health evaluation after completion of each upgrade domain. </maml:para> </maml:Description> <command:parameterValue required="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>MaxPercentDeltaUnhealthyNodes</maml:name> <maml:Description> <maml:para> The maximum allowed percentage of nodes health degradation allowed during cluster upgrades. The delta is measured between the state of the nodes at the beginning of upgrade and the state of the nodes at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion to make sure the global state of the cluster is within tolerated limits. The default value is 10%. </maml:para> </maml:Description> <command:parameterValue required="false">int?</command:parameterValue> <dev:type> <maml:name>int?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>MaxPercentUpgradeDomainDeltaUnhealthyNodes</maml:name> <maml:Description> <maml:para> The maximum allowed percentage of upgrade domain nodes health degradation allowed during cluster upgrades. The delta is measured between the state of the upgrade domain nodes at the beginning of upgrade and the state of the upgrade domain nodes at the time of the health evaluation. The check is performed after every upgrade domain upgrade completion for all completed upgrade domains to make sure the state of the upgrade domains is within tolerated limits. The default value is 15%. </maml:para> </maml:Description> <command:parameterValue required="false">int?</command:parameterValue> <dev:type> <maml:name>int?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>ApplicationHealthPolicyMap</maml:name> <maml:Description> <maml:para> The wrapper that contains the map with application health policies used to evaluate specific applications in the cluster. </maml:para> </maml:Description> <command:parameterValue required="false">IEnumerable<ApplicationHealthPolicyMapItem></command:parameterValue> <dev:type> <maml:name>IEnumerable<ApplicationHealthPolicyMapItem></maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-SFAadMetadata</command:name> <command:verb>Get</command:verb> <command:noun>AadMetadata</command:noun> <maml:description> <maml:para>Gets the Azure Active Directory metadata used for secured connection to cluster.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Gets the Azure Active Directory metadata used for secured connection to cluster. This API is not supposed to be called separately. It provides information needed to set up an Azure Active Directory secured connection with a Service Fabric cluster. </maml:para> </maml:description> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-SFClusterVersion</command:name> <command:verb>Get</command:verb> <command:noun>ClusterVersion</command:noun> <maml:description> <maml:para>Get the current Service Fabric cluster version.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>If a cluster upgrade is happening, then this API will return the lowest (older) version of the current and target cluster runtime versions. </maml:para> </maml:description> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-SFClusterLoad</command:name> <command:verb>Get</command:verb> <command:noun>ClusterLoad</command:noun> <maml:description> <maml:para>Gets the load of a Service Fabric cluster.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Retrieves the load information of a Service Fabric cluster for all the metrics that have load or capacity defined.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Switch-SFVerboseServicePlacementHealthReporting</command:name> <command:verb>Switch</command:verb> <command:noun>VerboseServicePlacementHealthReporting</command:noun> <maml:description> <maml:para>Changes the verbosity of service placement health reporting.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>If verbosity is set to true, then detailed health reports will be generated when replicas cannot be placed or dropped. If verbosity is set to false, then no health reports will be generated when replicas cannot be placed or dropped. </maml:para> </maml:description> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Enabled</maml:name> <maml:Description> <maml:para> The verbosity of service placement health reporting. </maml:para> </maml:Description> <command:parameterValue required="true">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-SFNode</command:name> <command:verb>Get</command:verb> <command:noun>Node</command:noun> <maml:description> <maml:para>Gets the list of nodes in the Service Fabric cluster.</maml:para> </maml:description> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-SFNode</maml:name> <command:parameter required="true"> <maml:name>NodeName</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>ServerTimeout</maml:name> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-SFNode</maml:name> <command:parameter required="false"> <maml:name>NodeStatusFilter</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>MaxResults</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>ServerTimeout</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <maml:description> <maml:para>The response includes the name, status, ID, health, uptime, and other details about the nodes.</maml:para> </maml:description> <command:parameters> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="0"> <maml:name>NodeName</maml:name> <maml:Description> <maml:para> The name of the node. </maml:para> </maml:Description> <command:parameterValue required="true">NodeName</command:parameterValue> <dev:type> <maml:name>NodeName</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>NodeStatusFilter</maml:name> <maml:Description> <maml:para> Allows filtering the nodes based on the NodeStatus. Only the nodes that are matching the specified filter value will be returned. The filter value can be one of the following. Possible values include: 'default', 'all', 'up', 'down', 'enabling', 'disabling', 'disabled', 'unknown', 'removed' </maml:para> </maml:Description> <command:parameterValue required="false">NodeStatusFilter?</command:parameterValue> <dev:type> <maml:name>NodeStatusFilter?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>MaxResults</maml:name> <maml:Description> <maml:para> The maximum number of results to be returned as part of the paged queries. This parameter defines the upper bound on the number of results returned. The results returned can be less than the specified maximum results if they do not fit in the message as per the max message size restrictions defined in the configuration. If this parameter is zero or not specified, the paged query includes as many results as possible that fit in the return message. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-SFNodeHealth</command:name> <command:verb>Get</command:verb> <command:noun>NodeHealth</command:noun> <maml:description> <maml:para>Gets the health of a Service Fabric node.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Gets the health of a Service Fabric node. Use EventsHealthStateFilter to filter the collection of health events reported on the node based on the health state. If the node that you specify by name does not exist in the health store, this returns an error.</maml:para> </maml:description> <command:parameters> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="0"> <maml:name>NodeName</maml:name> <maml:Description> <maml:para> The name of the node. </maml:para> </maml:Description> <command:parameterValue required="true">NodeName</command:parameterValue> <dev:type> <maml:name>NodeName</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>EventsHealthStateFilter</maml:name> <maml:Description> <maml:para> 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. - Default - Default value. Matches any HealthState. The value is zero. - 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. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - Error - Filter that matches input with HealthState value Error. The value is 8. - All - Filter that matches input with any HealthState value. The value is 65535. </maml:para> </maml:Description> <command:parameterValue required="false">int?</command:parameterValue> <dev:type> <maml:name>int?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-SFNodeHealthUsingPolicy</command:name> <command:verb>Get</command:verb> <command:noun>NodeHealthUsingPolicy</command:noun> <maml:description> <maml:para>Gets the health of a Service Fabric node, by using the specified health policy.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Gets the health of a Service Fabric node. Use EventsHealthStateFilter to filter the collection of health events reported on the node based on the health state. Use ClusterHealthPolicy in the POST body to override the health policies used to evaluate the health. If the node that you specify by name does not exist in the health store, this returns an error.</maml:para> </maml:description> <command:parameters> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="0"> <maml:name>NodeName</maml:name> <maml:Description> <maml:para> The name of the node. </maml:para> </maml:Description> <command:parameterValue required="true">NodeName</command:parameterValue> <dev:type> <maml:name>NodeName</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>EventsHealthStateFilter</maml:name> <maml:Description> <maml:para> 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. - Default - Default value. Matches any HealthState. The value is zero. - 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. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - Error - Filter that matches input with HealthState value Error. The value is 8. - All - Filter that matches input with any HealthState value. The value is 65535. </maml:para> </maml:Description> <command:parameterValue required="false">int?</command:parameterValue> <dev:type> <maml:name>int?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ConsiderWarningAsError</maml:name> <maml:Description> <maml:para> Indicates whether warnings are treated with the same severity as errors. </maml:para> </maml:Description> <command:parameterValue required="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>MaxPercentUnhealthyNodes</maml:name> <maml:Description> <maml:para> The maximum allowed percentage of unhealthy nodes before reporting an error. For example, to allow 10% of nodes to be unhealthy, this value would be 10. The percentage represents the maximum tolerated percentage of nodes that can be unhealthy before the cluster is considered in error. If the percentage is respected but there is at least one unhealthy node, the health is evaluated as Warning. The percentage is calculated by dividing the number of unhealthy nodes over the total number of nodes in the cluster. The computation rounds up to tolerate one failure on small numbers of nodes. Default percentage is zero. In large clusters, some nodes will always be down or out for repairs, so this percentage should be configured to tolerate that. </maml:para> </maml:Description> <command:parameterValue required="false">int?</command:parameterValue> <dev:type> <maml:name>int?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>MaxPercentUnhealthyApplications</maml:name> <maml:Description> <maml:para> The maximum allowed percentage of unhealthy applications before reporting an error. For example, to allow 10% of applications to be unhealthy, this value would be 10. The percentage represents the maximum tolerated percentage of applications that can be unhealthy before the cluster is considered in error. If the percentage is respected but there is at least one unhealthy application, the health is evaluated as Warning. This is calculated by dividing the number of unhealthy applications over the total number of application instances in the cluster, excluding applications of application types that are included in the ApplicationTypeHealthPolicyMap. The computation rounds up to tolerate one failure on small numbers of applications. Default percentage is zero. </maml:para> </maml:Description> <command:parameterValue required="false">int?</command:parameterValue> <dev:type> <maml:name>int?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>ApplicationTypeHealthPolicyMap</maml:name> <maml:Description> <maml:para> Defines a map with max percentage unhealthy applications for specific application types. Each entry specifies as key the application type name and as value an integer that represents the MaxPercentUnhealthyApplications percentage used to evaluate the applications of the specified application type. The application type health policy map can be used during cluster health evaluation to describe special application types. The application types included in the map are evaluated against the percentage specified in the map, and not with the global MaxPercentUnhealthyApplications defined in the cluster health policy. The applications of application types specified in the map are not counted against the global pool of applications. For example, if some applications of a type are critical, the cluster administrator can add an entry to the map for that application type and assign it a value of 0% (that is, do not tolerate any failures). All other applications can be evaluated with MaxPercentUnhealthyApplications set to 20% to tolerate some failures out of the thousands of application instances. The application type health policy map is used only if the cluster manifest enables application type health evaluation using the configuration entry for HealthManager/EnableApplicationTypeHealthEvaluation. </maml:para> </maml:Description> <command:parameterValue required="false">IEnumerable<ApplicationTypeHealthPolicyMapItem></command:parameterValue> <dev:type> <maml:name>IEnumerable<ApplicationTypeHealthPolicyMapItem></maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-SFNodeHealth</command:name> <command:verb>New</command:verb> <command:noun>NodeHealth</command:noun> <maml:description> <maml:para>Sends a health report on the Service Fabric node.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Reports health state of the specified Service Fabric node. The report must contain the information about the source of the health report and property on which it is reported. The report is sent to a Service Fabric gateway node, which forwards to the health store. The report may be accepted by the gateway, but rejected by the health store after extra validation. For example, the health store may reject the report because of an invalid parameter, like a stale sequence number. To see whether the report was applied in the health store, run GetNodeHealth and check that the report appears in the HealthEvents section. </maml:para> </maml:description> <command:parameters> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="0"> <maml:name>NodeName</maml:name> <maml:Description> <maml:para> The name of the node. </maml:para> </maml:Description> <command:parameterValue required="true">NodeName</command:parameterValue> <dev:type> <maml:name>NodeName</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>SourceId</maml:name> <maml:Description> <maml:para> The source name that identifies the client/watchdog/system component that generated the health information. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Property</maml:name> <maml:Description> <maml:para> The property of the health information. An entity can have health reports for different properties. The property is a string and not a fixed enumeration to allow the reporter flexibility to categorize the state condition that triggers the report. For example, a reporter with SourceId "LocalWatchdog" can monitor the state of the available disk on a node, so it can report "AvailableDisk" property on that node. The same reporter can monitor the node connectivity, so it can report a property "Connectivity" on the same node. In the health store, these reports are treated as separate health events for the specified node. Together with the SourceId, the property uniquely identifies the health information. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="3"> <maml:name>HealthState</maml:name> <maml:Description> <maml:para> The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown' </maml:para> </maml:Description> <command:parameterValue required="true">HealthState?</command:parameterValue> <dev:type> <maml:name>HealthState?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>TimeToLiveInMilliSeconds</maml:name> <maml:Description> <maml:para> The duration for which this health report is valid. This field uses ISO8601 format for specifying the duration. 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. </maml:para> </maml:Description> <command:parameterValue required="false">TimeSpan?</command:parameterValue> <dev:type> <maml:name>TimeSpan?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>Description</maml:name> <maml:Description> <maml:para> The description of the health information. It represents free text used to add human readable information about the report. The maximum string length for the description is 4096 characters. If the provided string is longer, it will be automatically truncated. When truncated, the last characters of the description contain a marker "[Truncated]", and total string size is 4096 characters. The presence of the marker indicates to users that truncation occurred. Note that when truncated, the description has less than 4096 characters from the original string. </maml:para> </maml:Description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>SequenceNumber</maml:name> <maml:Description> <maml:para> The sequence number for this health report as a numeric string. 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. </maml:para> </maml:Description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>RemoveWhenExpired</maml:name> <maml:Description> <maml:para> Value that indicates whether the report is removed from health store when it expires. 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, if 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. </maml:para> </maml:Description> <command:parameterValue required="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Immediate</maml:name> <maml:Description> <maml:para> A flag that indicates whether the report should be sent immediately. A health report is sent to a Service Fabric gateway Application, which forwards to the health store. If Immediate is set to true, the report is sent immediately from HTTP Gateway to the health store, regardless of the fabric client settings that the HTTP Gateway Application is using. This is useful for critical reports that should be sent as soon as possible. Depending on timing and other conditions, sending the report may still fail, for example if the HTTP Gateway is closed or the message doesn't reach the Gateway. If Immediate is set to false, the report is sent based on the health client settings from the HTTP Gateway. Therefore, it will be batched according to the HealthReportSendInterval configuration. This is the recommended setting because it allows the health client to optimize health reporting messages to health store as well as health report processing. By default, reports are not sent immediately. </maml:para> </maml:Description> <command:parameterValue required="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-SFNodeLoadInfo</command:name> <command:verb>Get</command:verb> <command:noun>NodeLoadInfo</command:noun> <maml:description> <maml:para>Gets the load information of a Service Fabric node.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Retrieves the load information of a Service Fabric node for all the metrics that have load or capacity defined.</maml:para> </maml:description> <command:parameters> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="0"> <maml:name>NodeName</maml:name> <maml:Description> <maml:para> The name of the node. </maml:para> </maml:Description> <command:parameterValue required="true">NodeName</command:parameterValue> <dev:type> <maml:name>NodeName</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Disable-SFNode</command:name> <command:verb>Disable</command:verb> <command:noun>Node</command:noun> <maml:description> <maml:para>Deactivate a Service Fabric cluster node with the specified deactivation intent.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Deactivate a Service Fabric cluster node with the specified deactivation intent. Once the deactivation is in progress, the deactivation intent can be increased, but not decreased (for example, a node that is deactivated with the Pause intent can be deactivated further with Restart, but not the other way around. Nodes may be reactivated using the Activate a node operation any time after they are deactivated. If the deactivation is not complete, this will cancel the deactivation. A node that goes down and comes back up while deactivated will still need to be reactivated before services will be placed on that node.</maml:para> </maml:description> <command:parameters> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="0"> <maml:name>NodeName</maml:name> <maml:Description> <maml:para> The name of the node. </maml:para> </maml:Description> <command:parameterValue required="true">NodeName</command:parameterValue> <dev:type> <maml:name>NodeName</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>DeactivationIntent</maml:name> <maml:Description> <maml:para> Describes the intent or reason for deactivating the node. The possible values are following. . Possible values include: 'Pause', 'Restart', 'RemoveData' </maml:para> </maml:Description> <command:parameterValue required="false">DeactivationIntent?</command:parameterValue> <dev:type> <maml:name>DeactivationIntent?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Enable-SFNode</command:name> <command:verb>Enable</command:verb> <command:noun>Node</command:noun> <maml:description> <maml:para>Activate a Service Fabric cluster node that is currently deactivated.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Activates a Service Fabric cluster node that is currently deactivated. Once activated, the node will again become a viable target for placing new replicas, and any deactivated replicas remaining on the node will be reactivated.</maml:para> </maml:description> <command:parameters> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="0"> <maml:name>NodeName</maml:name> <maml:Description> <maml:para> The name of the node. </maml:para> </maml:Description> <command:parameterValue required="true">NodeName</command:parameterValue> <dev:type> <maml:name>NodeName</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-SFNodeState</command:name> <command:verb>Remove</command:verb> <command:noun>NodeState</command:noun> <maml:description> <maml:para>Notifies Service Fabric that the persisted state on a node has been permanently removed or lost.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>This implies that it is not possible to recover the persisted state of that node. This generally happens if a hard disk has been wiped clean, or if a hard disk crashes. The node has to be down for this operation to be successful. This operation lets Service Fabric know that the replicas on that node no longer exist, and that Service Fabric should stop waiting for those replicas to come back up. Do not run this cmdlet if the state on the node has not been removed and the node can come back up with its state intact. Starting from Service Fabric 6.5, in order to use this API for seed nodes, please change the seed nodes to regular (non-seed) nodes and then invoke this API to remove the node state. If the cluster is running on Azure, after the seed node goes down, Service Fabric will try to change it to a non-seed node automatically. To make this happen, make sure the number of non-seed nodes in the primary node type is no less than the number of Down seed nodes. If necessary, add more nodes to the primary node type to achieve this. For standalone cluster, if the Down seed node is not expected to come back up with its state intact, please remove the node from the cluster, see https://docs.microsoft.com/en-us/azure/service-fabric/service-fabric-cluster-windows-server-add-remove-nodes</maml:para> </maml:description> <command:parameters> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="0"> <maml:name>NodeName</maml:name> <maml:Description> <maml:para> The name of the node. </maml:para> </maml:Description> <command:parameterValue required="true">NodeName</command:parameterValue> <dev:type> <maml:name>NodeName</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Restart-SFNode</command:name> <command:verb>Restart</command:verb> <command:noun>Node</command:noun> <maml:description> <maml:para>Restarts a Service Fabric cluster node.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Restarts a Service Fabric cluster node that is already started.</maml:para> </maml:description> <command:parameters> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="0"> <maml:name>NodeName</maml:name> <maml:Description> <maml:para> The name of the node. </maml:para> </maml:Description> <command:parameterValue required="true">NodeName</command:parameterValue> <dev:type> <maml:name>NodeName</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>NodeInstanceId</maml:name> <maml:Description> <maml:para> The instance ID of the target node. If instance ID is specified the node is restarted only if it matches with the current instance of the node. A default value of "0" would match any instance ID. The instance ID can be obtained using get node query. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>CreateFabricDump</maml:name> <maml:Description> <maml:para> Specify True to create a dump of the fabric node process. This is case-sensitive. Possible values include: 'False', 'True' </maml:para> </maml:Description> <command:parameterValue required="false">CreateFabricDump?</command:parameterValue> <dev:type> <maml:name>CreateFabricDump?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-SFApplicationType</command:name> <command:verb>Get</command:verb> <command:noun>ApplicationType</command:noun> <maml:description> <maml:para>Gets the list of application types in the Service Fabric cluster.</maml:para> </maml:description> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-SFApplicationType</maml:name> <command:parameter required="true"> <maml:name>ApplicationTypeName</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>ExcludeApplicationParameters</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>MaxResults</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>ServerTimeout</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>ApplicationTypeVersion</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>ContinuationToken</maml:name> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-SFApplicationType</maml:name> <command:parameter required="false"> <maml:name>ApplicationTypeDefinitionKindFilter</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>ExcludeApplicationParameters</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>MaxResults</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>ServerTimeout</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <maml:description> <maml:para>Returns the information about the application types that are provisioned or in the process of being provisioned in the Service Fabric cluster. Each version of an application type is returned as one application type. The response includes the name, version, status, and other details about the application type. This is a paged query, meaning that if not all of the application types fit in a page, one page of results is returned as well as a continuation token, which can be used to get the next page. For example, if there are 10 application types but a page only fits the first three application types, or if max results is set to 3, then three is returned. To access the rest of the results, retrieve subsequent pages by using the returned continuation token in the next query. An empty continuation token is returned if there are no subsequent pages.</maml:para> </maml:description> <command:parameters> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="0"> <maml:name>ApplicationTypeName</maml:name> <maml:Description> <maml:para> The name of the application type. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ApplicationTypeDefinitionKindFilter</maml:name> <maml:Description> <maml:para> Used to filter on ApplicationTypeDefinitionKind which is the mechanism used to define a Service Fabric application type. - Default - Default value, which performs the same function as selecting "All". The value is 0. - All - Filter that matches input with any ApplicationTypeDefinitionKind value. The value is 65535. - ServiceFabricApplicationPackage - Filter that matches input with ApplicationTypeDefinitionKind value ServiceFabricApplicationPackage. The value is 1. - Compose - Filter that matches input with ApplicationTypeDefinitionKind value Compose. The value is 2. </maml:para> </maml:Description> <command:parameterValue required="false">int?</command:parameterValue> <dev:type> <maml:name>int?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ExcludeApplicationParameters</maml:name> <maml:Description> <maml:para> The flag that specifies whether application parameters will be excluded from the result. </maml:para> </maml:Description> <command:parameterValue required="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>MaxResults</maml:name> <maml:Description> <maml:para> The maximum number of results to be returned as part of the paged queries. This parameter defines the upper bound on the number of results returned. The results returned can be less than the specified maximum results if they do not fit in the message as per the max message size restrictions defined in the configuration. If this parameter is zero or not specified, the paged query includes as many results as possible that fit in the return message. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>ApplicationTypeVersion</maml:name> <maml:Description> <maml:para> The version of the application type. </maml:para> </maml:Description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>ContinuationToken</maml:name> <maml:Description> <maml:para> The continuation token to obtain next set of results </maml:para> </maml:Description> <command:parameterValue required="false">ContinuationToken</command:parameterValue> <dev:type> <maml:name>ContinuationToken</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Register-SFApplicationType</command:name> <command:verb>Register</command:verb> <command:noun>ApplicationType</command:noun> <maml:description> <maml:para>Provisions or registers a Service Fabric application type with the cluster using the '.sfpkg' package in the external store or using the application package in the image store.</maml:para> </maml:description> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Register-SFApplicationType</maml:name> <command:parameter required="true"> <maml:name>ApplicationTypeBuildPath</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>ApplicationPackageCleanupPolicy</maml:name> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Register-SFApplicationType</maml:name> <command:parameter required="true"> <maml:name>ApplicationPackageDownloadUri</maml:name> </command:parameter> <command:parameter required="true"> <maml:name>ApplicationTypeName</maml:name> </command:parameter> <command:parameter required="true"> <maml:name>ApplicationTypeVersion</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <maml:description> <maml:para>Provisions a Service Fabric application type with the cluster. The provision is required before any new applications can be instantiated. The provision operation can be performed either on the application package specified by the relativePathInImageStore, or by using the URI of the external '.sfpkg'. </maml:para> </maml:description> <command:parameters> <command:parameter required="true" position="0"> <maml:name>ApplicationTypeBuildPath</maml:name> <maml:Description> <maml:para> The relative path for the application package in the image store specified during the prior upload operation. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>ApplicationPackageDownloadUri</maml:name> <maml:Description> <maml:para> The path to the '.sfpkg' application package from where the application package can be downloaded using HTTP or HTTPS protocols. The application package can be stored in an external store that provides GET operation to download the file. Supported protocols are HTTP and HTTPS, and the path must allow READ access. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>ApplicationTypeName</maml:name> <maml:Description> <maml:para> The application type name represents the name of the application type found in the application manifest. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="3"> <maml:name>ApplicationTypeVersion</maml:name> <maml:Description> <maml:para> The application type version represents the version of the application type found in the application manifest. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Async</maml:name> <maml:Description> <maml:para> Indicates whether or not provisioning should occur asynchronously. When set to true, the provision operation returns when the request is accepted by the system, and the provision operation continues without any timeout limit. The default value is false. For large application packages, we recommend setting the value to true. </maml:para> </maml:Description> <command:parameterValue required="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>ApplicationPackageCleanupPolicy</maml:name> <maml:Description> <maml:para> The kind of action that needs to be taken for cleaning up the application package after successful provision. Possible values include: 'Invalid', 'Default', 'Automatic', 'Manual' </maml:para> </maml:Description> <command:parameterValue required="false">ApplicationPackageCleanupPolicy?</command:parameterValue> <dev:type> <maml:name>ApplicationPackageCleanupPolicy?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Unregister-SFApplicationType</command:name> <command:verb>Unregister</command:verb> <command:noun>ApplicationType</command:noun> <maml:description> <maml:para>Removes or unregisters a Service Fabric application type from the cluster.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>This operation can only be performed if all application instances of the application type have been deleted. Once the application type is unregistered, no new application instances can be created for this particular application type.</maml:para> </maml:description> <command:parameters> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="0"> <maml:name>ApplicationTypeName</maml:name> <maml:Description> <maml:para> The name of the application type. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>ApplicationTypeVersion</maml:name> <maml:Description> <maml:para> The version of the application type as defined in the application manifest. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Async</maml:name> <maml:Description> <maml:para> The flag indicating whether or not unprovision should occur asynchronously. When set to true, the unprovision operation returns when the request is accepted by the system, and the unprovision operation continues without any timeout limit. The default value is false. However, we recommend setting it to true for large application packages that were provisioned. </maml:para> </maml:Description> <command:parameterValue required="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-SFApplicationManifest</command:name> <command:verb>Get</command:verb> <command:noun>ApplicationManifest</command:noun> <maml:description> <maml:para>Gets the manifest describing an application type.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>The response contains the application manifest XML as a string.</maml:para> </maml:description> <command:parameters> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="0"> <maml:name>ApplicationTypeName</maml:name> <maml:Description> <maml:para> The name of the application type. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="1"> <maml:name>ApplicationTypeVersion</maml:name> <maml:Description> <maml:para> The version of the application type. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-SFServiceType</command:name> <command:verb>Get</command:verb> <command:noun>ServiceType</command:noun> <maml:description> <maml:para>Gets the list containing the information about service types that are supported by a provisioned application type in a Service Fabric cluster.</maml:para> </maml:description> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-SFServiceType</maml:name> <command:parameter required="true"> <maml:name>ApplicationTypeName</maml:name> </command:parameter> <command:parameter required="true"> <maml:name>ApplicationTypeVersion</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>ServerTimeout</maml:name> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-SFServiceType</maml:name> <command:parameter required="true"> <maml:name>ApplicationTypeName</maml:name> </command:parameter> <command:parameter required="true"> <maml:name>ApplicationTypeVersion</maml:name> </command:parameter> <command:parameter required="true"> <maml:name>ServiceTypeName</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>ServerTimeout</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <maml:description> <maml:para>Gets the list containing the information about service types that are supported by a provisioned application type in a Service Fabric cluster. The provided application type must exist. Otherwise, a 404 status is returned.</maml:para> </maml:description> <command:parameters> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="0"> <maml:name>ApplicationTypeName</maml:name> <maml:Description> <maml:para> The name of the application type. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="1"> <maml:name>ApplicationTypeVersion</maml:name> <maml:Description> <maml:para> The version of the application type. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="2"> <maml:name>ServiceTypeName</maml:name> <maml:Description> <maml:para> Specifies the name of a Service Fabric service type. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-SFServiceManifest</command:name> <command:verb>Get</command:verb> <command:noun>ServiceManifest</command:noun> <maml:description> <maml:para>Gets the manifest describing a service type.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Gets the manifest describing a service type. The response contains the service manifest XML as a string.</maml:para> </maml:description> <command:parameters> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="0"> <maml:name>ApplicationTypeName</maml:name> <maml:Description> <maml:para> The name of the application type. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="1"> <maml:name>ApplicationTypeVersion</maml:name> <maml:Description> <maml:para> The version of the application type. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="2"> <maml:name>ServiceManifestName</maml:name> <maml:Description> <maml:para> The name of a service manifest registered as part of an application type in a Service Fabric cluster. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-SFDeployedServiceType</command:name> <command:verb>Get</command:verb> <command:noun>DeployedServiceType</command:noun> <maml:description> <maml:para>Gets the list containing the information about service types from the applications deployed on a node in a Service Fabric cluster.</maml:para> </maml:description> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-SFDeployedServiceType</maml:name> <command:parameter required="true"> <maml:name>NodeName</maml:name> </command:parameter> <command:parameter required="true"> <maml:name>ApplicationId</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>ServiceManifestName</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>ServerTimeout</maml:name> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-SFDeployedServiceType</maml:name> <command:parameter required="true"> <maml:name>NodeName</maml:name> </command:parameter> <command:parameter required="true"> <maml:name>ApplicationId</maml:name> </command:parameter> <command:parameter required="true"> <maml:name>ServiceTypeName</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>ServiceManifestName</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>ServerTimeout</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <maml:description> <maml:para>Gets the list containing the information about service types from the applications deployed on a node in a Service Fabric cluster. The response includes the name of the service type, its registration status, the code package that registered it and activation ID of the service package.</maml:para> </maml:description> <command:parameters> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="0"> <maml:name>NodeName</maml:name> <maml:Description> <maml:para> The name of the node. </maml:para> </maml:Description> <command:parameterValue required="true">NodeName</command:parameterValue> <dev:type> <maml:name>NodeName</maml:name> </dev:type> </command:parameter> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="1"> <maml:name>ApplicationId</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="2"> <maml:name>ServiceTypeName</maml:name> <maml:Description> <maml:para> Specifies the name of a Service Fabric service type. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>ServiceManifestName</maml:name> <maml:Description> <maml:para> The name of the service manifest to filter the list of deployed service type information. If specified, the response will only contain the information about service types that are defined in this service manifest. </maml:para> </maml:Description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-SFApplication</command:name> <command:verb>New</command:verb> <command:noun>Application</command:noun> <maml:description> <maml:para>Creates a Service Fabric application.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Creates a Service Fabric application using the specified description.</maml:para> </maml:description> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Name</maml:name> <maml:Description> <maml:para> The name of the application, including the 'fabric:' URI scheme. </maml:para> </maml:Description> <command:parameterValue required="true">ApplicationName</command:parameterValue> <dev:type> <maml:name>ApplicationName</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>TypeName</maml:name> <maml:Description> <maml:para> The application type name as defined in the application manifest. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>TypeVersion</maml:name> <maml:Description> <maml:para> The version of the application type as defined in the application manifest. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Parameters</maml:name> <maml:Description> <maml:para> List of application parameters with overridden values from their default values specified in the application manifest. </maml:para> </maml:Description> <command:parameterValue required="false">IReadOnlyDictionary<string, string></command:parameterValue> <dev:type> <maml:name>IReadOnlyDictionary<string, string></maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>MinimumNodes</maml:name> <maml:Description> <maml:para> The minimum number of nodes where Service Fabric will reserve capacity for this application. Note that this does not mean that the services of this application will be placed on all of those nodes. If this property is set to zero, no capacity will be reserved. The value of this property cannot be more than the value of the MaximumNodes property. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>MaximumNodes</maml:name> <maml:Description> <maml:para> The maximum number of nodes where Service Fabric will reserve capacity for this application. Note that this does not mean that the services of this application will be placed on all of those nodes. By default, the value of this property is zero and it means that the services can be placed on any node. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>ApplicationMetrics</maml:name> <maml:Description> <maml:para> List of application capacity metric description. </maml:para> </maml:Description> <command:parameterValue required="false">IEnumerable<ApplicationMetricDescription></command:parameterValue> <dev:type> <maml:name>IEnumerable<ApplicationMetricDescription></maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>TokenServiceEndpoint</maml:name> <maml:Description> <maml:para> Token service endpoint. </maml:para> </maml:Description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>ManagedIdentities</maml:name> <maml:Description> <maml:para> A list of managed application identity objects. </maml:para> </maml:Description> <command:parameterValue required="false">IEnumerable<ManagedApplicationIdentity></command:parameterValue> <dev:type> <maml:name>IEnumerable<ManagedApplicationIdentity></maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-SFApplication</command:name> <command:verb>Remove</command:verb> <command:noun>Application</command:noun> <maml:description> <maml:para>Deletes an existing Service Fabric application.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>An application must be created before it can be deleted. Deleting an application will delete all services that are part of that application. By default, Service Fabric will try to close service replicas in a graceful manner and then delete the service. However, if a service is having issues closing the replica gracefully, the delete operation may take a long time or get stuck. Use the optional ForceRemove flag to skip the graceful close sequence and forcefully delete the application and all of its services.</maml:para> </maml:description> <command:parameters> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="0"> <maml:name>ApplicationId</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ForceRemove</maml:name> <maml:Description> <maml:para> Remove a Service Fabric application or service forcefully without going through the graceful shutdown sequence. This parameter can be used to forcefully delete an application or service for which delete is timing out due to issues in the service code that prevents graceful close of replicas. </maml:para> </maml:Description> <command:parameterValue required="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-SFApplicationLoadInfo</command:name> <command:verb>Get</command:verb> <command:noun>ApplicationLoadInfo</command:noun> <maml:description> <maml:para>Gets load information about a Service Fabric application.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Returns the load information about the application that was created or in the process of being created in the Service Fabric cluster and whose name matches the one specified as the parameter. The response includes the name, minimum nodes, maximum nodes, the number of nodes the application is occupying currently, and application load metric information about the application.</maml:para> </maml:description> <command:parameters> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="0"> <maml:name>ApplicationId</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-SFApplication</command:name> <command:verb>Get</command:verb> <command:noun>Application</command:noun> <maml:description> <maml:para>Gets the list of applications created in the Service Fabric cluster that match the specified filters.</maml:para> </maml:description> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-SFApplication</maml:name> <command:parameter required="true"> <maml:name>ApplicationId</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>ExcludeApplicationParameters</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>ServerTimeout</maml:name> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-SFApplication</maml:name> <command:parameter required="false"> <maml:name>ApplicationDefinitionKindFilter</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>ApplicationTypeName</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>ExcludeApplicationParameters</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>MaxResults</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>ServerTimeout</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <maml:description> <maml:para>Gets the information about the applications that were created or in the process of being created in the Service Fabric cluster and match the specified filters. The response includes the name, type, status, parameters, and other details about the application. If the applications do not fit in a page, one page of results is returned as well as a continuation token, which can be used to get the next page. Filters ApplicationTypeName and ApplicationDefinitionKindFilter cannot be specified at the same time.</maml:para> </maml:description> <command:parameters> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="0"> <maml:name>ApplicationId</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ApplicationDefinitionKindFilter</maml:name> <maml:Description> <maml:para> Used to filter on ApplicationDefinitionKind, which is the mechanism used to define a Service Fabric application. - Default - Default value, which performs the same function as selecting "All". The value is 0. - All - Filter that matches input with any ApplicationDefinitionKind value. The value is 65535. - ServiceFabricApplicationDescription - Filter that matches input with ApplicationDefinitionKind value ServiceFabricApplicationDescription. The value is 1. - Compose - Filter that matches input with ApplicationDefinitionKind value Compose. The value is 2. </maml:para> </maml:Description> <command:parameterValue required="false">int?</command:parameterValue> <dev:type> <maml:name>int?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ApplicationTypeName</maml:name> <maml:Description> <maml:para> The application type name used to filter the applications to query for. This value should not contain the application type version. </maml:para> </maml:Description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>ExcludeApplicationParameters</maml:name> <maml:Description> <maml:para> The flag that specifies whether application parameters will be excluded from the result. </maml:para> </maml:Description> <command:parameterValue required="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>MaxResults</maml:name> <maml:Description> <maml:para> The maximum number of results to be returned as part of the paged queries. This parameter defines the upper bound on the number of results returned. The results returned can be less than the specified maximum results if they do not fit in the message as per the max message size restrictions defined in the configuration. If this parameter is zero or not specified, the paged query includes as many results as possible that fit in the return message. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-SFApplicationHealth</command:name> <command:verb>Get</command:verb> <command:noun>ApplicationHealth</command:noun> <maml:description> <maml:para>Gets the health of the service fabric application.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Returns the heath state of the service fabric application. The response reports either Ok, Error or Warning health state. If the entity is not found in the health store, it will return Error.</maml:para> </maml:description> <command:parameters> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="0"> <maml:name>ApplicationId</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>EventsHealthStateFilter</maml:name> <maml:Description> <maml:para> 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. - Default - Default value. Matches any HealthState. The value is zero. - 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. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - Error - Filter that matches input with HealthState value Error. The value is 8. - All - Filter that matches input with any HealthState value. The value is 65535. </maml:para> </maml:Description> <command:parameterValue required="false">int?</command:parameterValue> <dev:type> <maml:name>int?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>DeployedApplicationsHealthStateFilter</maml:name> <maml:Description> <maml:para> Allows filtering of the deployed applications health state objects returned in the result of application health query based on their health state. The possible values for this parameter include integer value of one of the following health states. Only deployed applications that match the filter will be returned. All deployed 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 deployed applications with HealthState value of OK (2) and Warning (4) are returned. - Default - Default value. Matches any HealthState. The value is zero. - 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. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - Error - Filter that matches input with HealthState value Error. The value is 8. - All - Filter that matches input with any HealthState value. The value is 65535. </maml:para> </maml:Description> <command:parameterValue required="false">int?</command:parameterValue> <dev:type> <maml:name>int?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>ServicesHealthStateFilter</maml:name> <maml:Description> <maml:para> Allows filtering of the services health state objects returned in the result of services health query based on their health state. The possible values for this parameter include integer value of one of the following health states. Only services that match the filter are returned. All services 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 services with HealthState value of OK (2) and Warning (4) will be returned. - Default - Default value. Matches any HealthState. The value is zero. - 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. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - Error - Filter that matches input with HealthState value Error. The value is 8. - All - Filter that matches input with any HealthState value. The value is 65535. </maml:para> </maml:Description> <command:parameterValue required="false">int?</command:parameterValue> <dev:type> <maml:name>int?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>ExcludeHealthStatistics</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-SFApplicationHealthUsingPolicy</command:name> <command:verb>Get</command:verb> <command:noun>ApplicationHealthUsingPolicy</command:noun> <maml:description> <maml:para>Gets the health of a Service Fabric application using the specified policy.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Gets the health of a Service Fabric application. Use EventsHealthStateFilter to filter the collection of health events reported on the node based on the health state. Use ClusterHealthPolicies to override the health policies used to evaluate the health.</maml:para> </maml:description> <command:parameters> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="0"> <maml:name>ApplicationId</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>EventsHealthStateFilter</maml:name> <maml:Description> <maml:para> 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. - Default - Default value. Matches any HealthState. The value is zero. - 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. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - Error - Filter that matches input with HealthState value Error. The value is 8. - All - Filter that matches input with any HealthState value. The value is 65535. </maml:para> </maml:Description> <command:parameterValue required="false">int?</command:parameterValue> <dev:type> <maml:name>int?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>DeployedApplicationsHealthStateFilter</maml:name> <maml:Description> <maml:para> Allows filtering of the deployed applications health state objects returned in the result of application health query based on their health state. The possible values for this parameter include integer value of one of the following health states. Only deployed applications that match the filter will be returned. All deployed 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 deployed applications with HealthState value of OK (2) and Warning (4) are returned. - Default - Default value. Matches any HealthState. The value is zero. - 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. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - Error - Filter that matches input with HealthState value Error. The value is 8. - All - Filter that matches input with any HealthState value. The value is 65535. </maml:para> </maml:Description> <command:parameterValue required="false">int?</command:parameterValue> <dev:type> <maml:name>int?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>ServicesHealthStateFilter</maml:name> <maml:Description> <maml:para> Allows filtering of the services health state objects returned in the result of services health query based on their health state. The possible values for this parameter include integer value of one of the following health states. Only services that match the filter are returned. All services 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 services with HealthState value of OK (2) and Warning (4) will be returned. - Default - Default value. Matches any HealthState. The value is zero. - 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. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - Error - Filter that matches input with HealthState value Error. The value is 8. - All - Filter that matches input with any HealthState value. The value is 65535. </maml:para> </maml:Description> <command:parameterValue required="false">int?</command:parameterValue> <dev:type> <maml:name>int?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>ExcludeHealthStatistics</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>ConsiderWarningAsError</maml:name> <maml:Description> <maml:para> Indicates whether warnings are treated with the same severity as errors. </maml:para> </maml:Description> <command:parameterValue required="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>MaxPercentUnhealthyDeployedApplications</maml:name> <maml:Description> <maml:para> The maximum allowed percentage of unhealthy deployed applications. Allowed values are Byte values from zero to 100. The percentage represents the maximum tolerated percentage of deployed applications that can be unhealthy before the application is considered in error. This is calculated by dividing the number of unhealthy deployed applications over the number of nodes where the application is currently deployed on in the cluster. The computation rounds up to tolerate one failure on small numbers of nodes. Default percentage is zero. </maml:para> </maml:Description> <command:parameterValue required="false">int?</command:parameterValue> <dev:type> <maml:name>int?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>MaxPercentUnhealthyPartitionsPerService</maml:name> <maml:Description> <maml:para> The maximum allowed percentage of unhealthy partitions per service. Allowed values are Byte values from zero to 100 The percentage represents the maximum tolerated percentage of partitions that can be unhealthy before the service is considered in error. If the percentage is respected but there is at least one unhealthy partition, the health is evaluated as Warning. The percentage is calculated by dividing the number of unhealthy partitions over the total number of partitions in the service. The computation rounds up to tolerate one failure on small numbers of partitions. Default percentage is zero. </maml:para> </maml:Description> <command:parameterValue required="false">int?</command:parameterValue> <dev:type> <maml:name>int?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>MaxPercentUnhealthyReplicasPerPartition</maml:name> <maml:Description> <maml:para> The maximum allowed percentage of unhealthy replicas per partition. Allowed values are Byte values from zero to 100. The percentage represents the maximum tolerated percentage of replicas that can be unhealthy before the partition is considered in error. If the percentage is respected but there is at least one unhealthy replica, the health is evaluated as Warning. The percentage is calculated by dividing the number of unhealthy replicas over the total number of replicas in the partition. The computation rounds up to tolerate one failure on small numbers of replicas. Default percentage is zero. </maml:para> </maml:Description> <command:parameterValue required="false">int?</command:parameterValue> <dev:type> <maml:name>int?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>MaxPercentUnhealthyServices</maml:name> <maml:Description> <maml:para> The maximum allowed percentage of unhealthy services. Allowed values are Byte values from zero to 100. The percentage represents the maximum tolerated percentage of services that can be unhealthy before the application is considered in error. If the percentage is respected but there is at least one unhealthy service, the health is evaluated as Warning. This is calculated by dividing the number of unhealthy services of the specific service type over the total number of services of the specific service type. The computation rounds up to tolerate one failure on small numbers of services. Default percentage is zero. </maml:para> </maml:Description> <command:parameterValue required="false">int?</command:parameterValue> <dev:type> <maml:name>int?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>ServiceTypeHealthPolicyMap</maml:name> <maml:Description> <maml:para> The map with service type health policy per service type name. The map is empty by default. </maml:para> </maml:Description> <command:parameterValue required="false">IEnumerable<ServiceTypeHealthPolicyMapItem></command:parameterValue> <dev:type> <maml:name>IEnumerable<ServiceTypeHealthPolicyMapItem></maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-SFApplicationHealth</command:name> <command:verb>New</command:verb> <command:noun>ApplicationHealth</command:noun> <maml:description> <maml:para>Sends a health report on the Service Fabric application.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Reports health state of the specified Service Fabric application. The report must contain the information about the source of the health report and property on which it is reported. The report is sent to a Service Fabric gateway Application, which forwards to the health store. The report may be accepted by the gateway, but rejected by the health store after extra validation. For example, the health store may reject the report because of an invalid parameter, like a stale sequence number. To see whether the report was applied in the health store, get application health and check that the report appears in the HealthEvents section. </maml:para> </maml:description> <command:parameters> <command:parameter required="true" position="0"> <maml:name>ApplicationId</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>SourceId</maml:name> <maml:Description> <maml:para> The source name that identifies the client/watchdog/system component that generated the health information. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Property</maml:name> <maml:Description> <maml:para> The property of the health information. An entity can have health reports for different properties. The property is a string and not a fixed enumeration to allow the reporter flexibility to categorize the state condition that triggers the report. For example, a reporter with SourceId "LocalWatchdog" can monitor the state of the available disk on a node, so it can report "AvailableDisk" property on that node. The same reporter can monitor the node connectivity, so it can report a property "Connectivity" on the same node. In the health store, these reports are treated as separate health events for the specified node. Together with the SourceId, the property uniquely identifies the health information. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="3"> <maml:name>HealthState</maml:name> <maml:Description> <maml:para> The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown' </maml:para> </maml:Description> <command:parameterValue required="true">HealthState?</command:parameterValue> <dev:type> <maml:name>HealthState?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>TimeToLiveInMilliSeconds</maml:name> <maml:Description> <maml:para> The duration for which this health report is valid. This field uses ISO8601 format for specifying the duration. 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. </maml:para> </maml:Description> <command:parameterValue required="false">TimeSpan?</command:parameterValue> <dev:type> <maml:name>TimeSpan?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>Description</maml:name> <maml:Description> <maml:para> The description of the health information. It represents free text used to add human readable information about the report. The maximum string length for the description is 4096 characters. If the provided string is longer, it will be automatically truncated. When truncated, the last characters of the description contain a marker "[Truncated]", and total string size is 4096 characters. The presence of the marker indicates to users that truncation occurred. Note that when truncated, the description has less than 4096 characters from the original string. </maml:para> </maml:Description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>SequenceNumber</maml:name> <maml:Description> <maml:para> The sequence number for this health report as a numeric string. 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. </maml:para> </maml:Description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>RemoveWhenExpired</maml:name> <maml:Description> <maml:para> Value that indicates whether the report is removed from health store when it expires. 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, if 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. </maml:para> </maml:Description> <command:parameterValue required="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Immediate</maml:name> <maml:Description> <maml:para> A flag that indicates whether the report should be sent immediately. A health report is sent to a Service Fabric gateway Application, which forwards to the health store. If Immediate is set to true, the report is sent immediately from HTTP Gateway to the health store, regardless of the fabric client settings that the HTTP Gateway Application is using. This is useful for critical reports that should be sent as soon as possible. Depending on timing and other conditions, sending the report may still fail, for example if the HTTP Gateway is closed or the message doesn't reach the Gateway. If Immediate is set to false, the report is sent based on the health client settings from the HTTP Gateway. Therefore, it will be batched according to the HealthReportSendInterval configuration. This is the recommended setting because it allows the health client to optimize health reporting messages to health store as well as health report processing. By default, reports are not sent immediately. </maml:para> </maml:Description> <command:parameterValue required="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-SFApplicationUpgrade</command:name> <command:verb>Get</command:verb> <command:noun>ApplicationUpgrade</command:noun> <maml:description> <maml:para>Gets details for the latest upgrade performed on this application.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Returns information about the state of the latest application upgrade along with details to aid debugging application health issues.</maml:para> </maml:description> <command:parameters> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="0"> <maml:name>ApplicationId</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Update-SFApplicationUpgrade</command:name> <command:verb>Update</command:verb> <command:noun>ApplicationUpgrade</command:noun> <maml:description> <maml:para>Updates an ongoing application upgrade in the Service Fabric cluster.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Updates the parameters of an ongoing application upgrade from the ones specified at the time of starting the application upgrade. This may be required to mitigate stuck application upgrades due to incorrect parameters or issues in the application to make progress.</maml:para> </maml:description> <command:parameters> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="0"> <maml:name>ApplicationId</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>Name</maml:name> <maml:Description> <maml:para> The name of the application, including the 'fabric:' URI scheme. </maml:para> </maml:Description> <command:parameterValue required="true">ApplicationName</command:parameterValue> <dev:type> <maml:name>ApplicationName</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>UpgradeKind</maml:name> <maml:Description> <maml:para> The kind of upgrade out of the following possible values. Possible values include: 'Invalid', 'Rolling' </maml:para> </maml:Description> <command:parameterValue required="true">UpgradeKind?</command:parameterValue> <dev:type> <maml:name>UpgradeKind?</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="3"> <maml:name>RollingUpgradeMode</maml:name> <maml:Description> <maml:para> The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, and Monitored. Possible values include: 'Invalid', 'UnmonitoredAuto', 'UnmonitoredManual', 'Monitored' </maml:para> </maml:Description> <command:parameterValue required="true">UpgradeMode?</command:parameterValue> <dev:type> <maml:name>UpgradeMode?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>ConsiderWarningAsError</maml:name> <maml:Description> <maml:para> Indicates whether warnings are treated with the same severity as errors. </maml:para> </maml:Description> <command:parameterValue required="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>MaxPercentUnhealthyDeployedApplications</maml:name> <maml:Description> <maml:para> The maximum allowed percentage of unhealthy deployed applications. Allowed values are Byte values from zero to 100. The percentage represents the maximum tolerated percentage of deployed applications that can be unhealthy before the application is considered in error. This is calculated by dividing the number of unhealthy deployed applications over the number of nodes where the application is currently deployed on in the cluster. The computation rounds up to tolerate one failure on small numbers of nodes. Default percentage is zero. </maml:para> </maml:Description> <command:parameterValue required="false">int?</command:parameterValue> <dev:type> <maml:name>int?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>MaxPercentUnhealthyPartitionsPerService</maml:name> <maml:Description> <maml:para> The maximum allowed percentage of unhealthy partitions per service. Allowed values are Byte values from zero to 100 The percentage represents the maximum tolerated percentage of partitions that can be unhealthy before the service is considered in error. If the percentage is respected but there is at least one unhealthy partition, the health is evaluated as Warning. The percentage is calculated by dividing the number of unhealthy partitions over the total number of partitions in the service. The computation rounds up to tolerate one failure on small numbers of partitions. Default percentage is zero. </maml:para> </maml:Description> <command:parameterValue required="false">int?</command:parameterValue> <dev:type> <maml:name>int?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>MaxPercentUnhealthyReplicasPerPartition</maml:name> <maml:Description> <maml:para> The maximum allowed percentage of unhealthy replicas per partition. Allowed values are Byte values from zero to 100. The percentage represents the maximum tolerated percentage of replicas that can be unhealthy before the partition is considered in error. If the percentage is respected but there is at least one unhealthy replica, the health is evaluated as Warning. The percentage is calculated by dividing the number of unhealthy replicas over the total number of replicas in the partition. The computation rounds up to tolerate one failure on small numbers of replicas. Default percentage is zero. </maml:para> </maml:Description> <command:parameterValue required="false">int?</command:parameterValue> <dev:type> <maml:name>int?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>MaxPercentUnhealthyServices</maml:name> <maml:Description> <maml:para> The maximum allowed percentage of unhealthy services. Allowed values are Byte values from zero to 100. The percentage represents the maximum tolerated percentage of services that can be unhealthy before the application is considered in error. If the percentage is respected but there is at least one unhealthy service, the health is evaluated as Warning. This is calculated by dividing the number of unhealthy services of the specific service type over the total number of services of the specific service type. The computation rounds up to tolerate one failure on small numbers of services. Default percentage is zero. </maml:para> </maml:Description> <command:parameterValue required="false">int?</command:parameterValue> <dev:type> <maml:name>int?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>ServiceTypeHealthPolicyMap</maml:name> <maml:Description> <maml:para> The map with service type health policy per service type name. The map is empty by default. </maml:para> </maml:Description> <command:parameterValue required="false">IEnumerable<ServiceTypeHealthPolicyMapItem></command:parameterValue> <dev:type> <maml:name>IEnumerable<ServiceTypeHealthPolicyMapItem></maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>ForceRestart</maml:name> <maml:Description> <maml:para> If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data). </maml:para> </maml:Description> <command:parameterValue required="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>ReplicaSetCheckTimeoutInMilliseconds</maml:name> <maml:Description> <maml:para> The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. Valid values are between 0 and 42949672925 inclusive. (unsigned 32-bit integer). </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>FailureAction</maml:name> <maml:Description> <maml:para> The compensating action to perform when a Monitored upgrade encounters monitoring policy or health policy violations. Invalid indicates the failure action is invalid. Rollback specifies that the upgrade will start rolling back automatically. Manual indicates that the upgrade will switch to UnmonitoredManual upgrade mode. . Possible values include: 'Invalid', 'Rollback', 'Manual' </maml:para> </maml:Description> <command:parameterValue required="false">FailureAction?</command:parameterValue> <dev:type> <maml:name>FailureAction?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>HealthCheckWaitDurationInMilliseconds</maml:name> <maml:Description> <maml:para> The amount of time to wait after completing an upgrade domain before applying health policies. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds. </maml:para> </maml:Description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>HealthCheckStableDurationInMilliseconds</maml:name> <maml:Description> <maml:para> The amount of time that the application or cluster must remain healthy before the upgrade proceeds to the next upgrade domain. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds. </maml:para> </maml:Description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>HealthCheckRetryTimeoutInMilliseconds</maml:name> <maml:Description> <maml:para> The amount of time to retry health evaluation when the application or cluster is unhealthy before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds. </maml:para> </maml:Description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>UpgradeTimeoutInMilliseconds</maml:name> <maml:Description> <maml:para> The amount of time the overall upgrade has to complete before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds. </maml:para> </maml:Description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>UpgradeDomainTimeoutInMilliseconds</maml:name> <maml:Description> <maml:para> The amount of time each upgrade domain has to complete before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds. </maml:para> </maml:Description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Resume-SFApplicationUpgrade</command:name> <command:verb>Resume</command:verb> <command:noun>ApplicationUpgrade</command:noun> <maml:description> <maml:para>Resumes upgrading an application in the Service Fabric cluster.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Resumes an unmonitored manual Service Fabric application upgrade. Service Fabric upgrades one upgrade domain at a time. For unmonitored manual upgrades, after Service Fabric finishes an upgrade domain, it waits for you to call this API before proceeding to the next upgrade domain.</maml:para> </maml:description> <command:parameters> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="0"> <maml:name>ApplicationId</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>UpgradeDomainName</maml:name> <maml:Description> <maml:para> The name of the upgrade domain in which to resume the upgrade. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-SFApplicationUpgrade</command:name> <command:verb>New</command:verb> <command:noun>ApplicationUpgrade</command:noun> <maml:description> <maml:para>Starts rolling back the currently on-going upgrade of an application in the Service Fabric cluster.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Starts rolling back the current application upgrade to the previous version. This API can only be used to roll back the current in-progress upgrade that is rolling forward to new version. If the application is not currently being upgraded use StartApplicationUpgrade API to upgrade it to desired version, including rolling back to a previous version.</maml:para> </maml:description> <command:parameters> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="0"> <maml:name>ApplicationId</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-SFDeployedApplication</command:name> <command:verb>Get</command:verb> <command:noun>DeployedApplication</command:noun> <maml:description> <maml:para>Gets the list of applications deployed on a Service Fabric node.</maml:para> </maml:description> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-SFDeployedApplication</maml:name> <command:parameter required="true"> <maml:name>NodeName</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>ServerTimeout</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>IncludeHealthState</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>MaxResults</maml:name> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-SFDeployedApplication</maml:name> <command:parameter required="true"> <maml:name>NodeName</maml:name> </command:parameter> <command:parameter required="true"> <maml:name>ApplicationId</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>ServerTimeout</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>IncludeHealthState</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <maml:description> <maml:para>Gets the list of applications deployed on a Service Fabric node. The results do not include information about deployed system applications unless explicitly queried for by ID. Results encompass deployed applications in active, activating, and downloading states. This query requires that the node name corresponds to a node on the cluster. The query fails if the provided node name does not point to any active Service Fabric nodes on the cluster. </maml:para> </maml:description> <command:parameters> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="0"> <maml:name>NodeName</maml:name> <maml:Description> <maml:para> The name of the node. </maml:para> </maml:Description> <command:parameterValue required="true">NodeName</command:parameterValue> <dev:type> <maml:name>NodeName</maml:name> </dev:type> </command:parameter> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="1"> <maml:name>ApplicationId</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>IncludeHealthState</maml:name> <maml:Description> <maml:para> Include the health state of an entity. If this parameter is false or not specified, then the health state returned is "Unknown". When set to true, the query goes in parallel to the node and the health system service before the results are merged. As a result, the query is more expensive and may take a longer time. </maml:para> </maml:Description> <command:parameterValue required="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>MaxResults</maml:name> <maml:Description> <maml:para> The maximum number of results to be returned as part of the paged queries. This parameter defines the upper bound on the number of results returned. The results returned can be less than the specified maximum results if they do not fit in the message as per the max message size restrictions defined in the configuration. If this parameter is zero or not specified, the paged query includes as many results as possible that fit in the return message. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-SFDeployedApplicationHealth</command:name> <command:verb>Get</command:verb> <command:noun>DeployedApplicationHealth</command:noun> <maml:description> <maml:para>Gets the information about health of an application deployed on a Service Fabric node.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Gets the information about health of an application deployed on a Service Fabric node. Use EventsHealthStateFilter to optionally filter for the collection of HealthEvent objects reported on the deployed application based on health state. Use DeployedServicePackagesHealthStateFilter to optionally filter for DeployedServicePackageHealth children based on health state.</maml:para> </maml:description> <command:parameters> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="0"> <maml:name>NodeName</maml:name> <maml:Description> <maml:para> The name of the node. </maml:para> </maml:Description> <command:parameterValue required="true">NodeName</command:parameterValue> <dev:type> <maml:name>NodeName</maml:name> </dev:type> </command:parameter> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="1"> <maml:name>ApplicationId</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>EventsHealthStateFilter</maml:name> <maml:Description> <maml:para> 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. - Default - Default value. Matches any HealthState. The value is zero. - 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. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - Error - Filter that matches input with HealthState value Error. The value is 8. - All - Filter that matches input with any HealthState value. The value is 65535. </maml:para> </maml:Description> <command:parameterValue required="false">int?</command:parameterValue> <dev:type> <maml:name>int?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DeployedServicePackagesHealthStateFilter</maml:name> <maml:Description> <maml:para> Allows filtering of the deployed service package health state objects returned in the result of deployed application health query based on their health state. The possible values for this parameter include integer value of one of the following health states. Only deployed service packages that match the filter are returned. All deployed service packages are used to evaluate the aggregated health state of the deployed application. If not specified, all entries are returned. The state values are flag-based enumeration, so the value can be a combination of these values, obtained using the bitwise 'OR' operator. For example, if the provided value is 6 then health state of service packages with HealthState value of OK (2) and Warning (4) are returned. - Default - Default value. Matches any HealthState. The value is zero. - 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. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - Error - Filter that matches input with HealthState value Error. The value is 8. - All - Filter that matches input with any HealthState value. The value is 65535. </maml:para> </maml:Description> <command:parameterValue required="false">int?</command:parameterValue> <dev:type> <maml:name>int?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>ExcludeHealthStatistics</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-SFDeployedApplicationHealthUsingPolicy</command:name> <command:verb>Get</command:verb> <command:noun>DeployedApplicationHealthUsingPolicy</command:noun> <maml:description> <maml:para>Gets the information about health of an application deployed on a Service Fabric node. using the specified policy.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Gets the information about health of an application deployed on a Service Fabric node using the specified policy. Use EventsHealthStateFilter to optionally filter for the collection of HealthEvent objects reported on the deployed application based on health state. Use DeployedServicePackagesHealthStateFilter to optionally filter for DeployedServicePackageHealth children based on health state. Use ApplicationHealthPolicy to optionally override the health policies used to evaluate the health. This API only uses 'ConsiderWarningAsError' field of the ApplicationHealthPolicy. The rest of the fields are ignored while evaluating the health of the deployed application. </maml:para> </maml:description> <command:parameters> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="0"> <maml:name>NodeName</maml:name> <maml:Description> <maml:para> The name of the node. </maml:para> </maml:Description> <command:parameterValue required="true">NodeName</command:parameterValue> <dev:type> <maml:name>NodeName</maml:name> </dev:type> </command:parameter> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="1"> <maml:name>ApplicationId</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>EventsHealthStateFilter</maml:name> <maml:Description> <maml:para> 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. - Default - Default value. Matches any HealthState. The value is zero. - 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. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - Error - Filter that matches input with HealthState value Error. The value is 8. - All - Filter that matches input with any HealthState value. The value is 65535. </maml:para> </maml:Description> <command:parameterValue required="false">int?</command:parameterValue> <dev:type> <maml:name>int?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>DeployedServicePackagesHealthStateFilter</maml:name> <maml:Description> <maml:para> Allows filtering of the deployed service package health state objects returned in the result of deployed application health query based on their health state. The possible values for this parameter include integer value of one of the following health states. Only deployed service packages that match the filter are returned. All deployed service packages are used to evaluate the aggregated health state of the deployed application. If not specified, all entries are returned. The state values are flag-based enumeration, so the value can be a combination of these values, obtained using the bitwise 'OR' operator. For example, if the provided value is 6 then health state of service packages with HealthState value of OK (2) and Warning (4) are returned. - Default - Default value. Matches any HealthState. The value is zero. - 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. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - Error - Filter that matches input with HealthState value Error. The value is 8. - All - Filter that matches input with any HealthState value. The value is 65535. </maml:para> </maml:Description> <command:parameterValue required="false">int?</command:parameterValue> <dev:type> <maml:name>int?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>ConsiderWarningAsError</maml:name> <maml:Description> <maml:para> Indicates whether warnings are treated with the same severity as errors. </maml:para> </maml:Description> <command:parameterValue required="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>MaxPercentUnhealthyDeployedApplications</maml:name> <maml:Description> <maml:para> The maximum allowed percentage of unhealthy deployed applications. Allowed values are Byte values from zero to 100. The percentage represents the maximum tolerated percentage of deployed applications that can be unhealthy before the application is considered in error. This is calculated by dividing the number of unhealthy deployed applications over the number of nodes where the application is currently deployed on in the cluster. The computation rounds up to tolerate one failure on small numbers of nodes. Default percentage is zero. </maml:para> </maml:Description> <command:parameterValue required="false">int?</command:parameterValue> <dev:type> <maml:name>int?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>MaxPercentUnhealthyPartitionsPerService</maml:name> <maml:Description> <maml:para> The maximum allowed percentage of unhealthy partitions per service. Allowed values are Byte values from zero to 100 The percentage represents the maximum tolerated percentage of partitions that can be unhealthy before the service is considered in error. If the percentage is respected but there is at least one unhealthy partition, the health is evaluated as Warning. The percentage is calculated by dividing the number of unhealthy partitions over the total number of partitions in the service. The computation rounds up to tolerate one failure on small numbers of partitions. Default percentage is zero. </maml:para> </maml:Description> <command:parameterValue required="false">int?</command:parameterValue> <dev:type> <maml:name>int?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>MaxPercentUnhealthyReplicasPerPartition</maml:name> <maml:Description> <maml:para> The maximum allowed percentage of unhealthy replicas per partition. Allowed values are Byte values from zero to 100. The percentage represents the maximum tolerated percentage of replicas that can be unhealthy before the partition is considered in error. If the percentage is respected but there is at least one unhealthy replica, the health is evaluated as Warning. The percentage is calculated by dividing the number of unhealthy replicas over the total number of replicas in the partition. The computation rounds up to tolerate one failure on small numbers of replicas. Default percentage is zero. </maml:para> </maml:Description> <command:parameterValue required="false">int?</command:parameterValue> <dev:type> <maml:name>int?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>MaxPercentUnhealthyServices</maml:name> <maml:Description> <maml:para> The maximum allowed percentage of unhealthy services. Allowed values are Byte values from zero to 100. The percentage represents the maximum tolerated percentage of services that can be unhealthy before the application is considered in error. If the percentage is respected but there is at least one unhealthy service, the health is evaluated as Warning. This is calculated by dividing the number of unhealthy services of the specific service type over the total number of services of the specific service type. The computation rounds up to tolerate one failure on small numbers of services. Default percentage is zero. </maml:para> </maml:Description> <command:parameterValue required="false">int?</command:parameterValue> <dev:type> <maml:name>int?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>ServiceTypeHealthPolicyMap</maml:name> <maml:Description> <maml:para> The map with service type health policy per service type name. The map is empty by default. </maml:para> </maml:Description> <command:parameterValue required="false">IEnumerable<ServiceTypeHealthPolicyMapItem></command:parameterValue> <dev:type> <maml:name>IEnumerable<ServiceTypeHealthPolicyMapItem></maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>ExcludeHealthStatistics</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-SFDeployedApplicationHealth</command:name> <command:verb>New</command:verb> <command:noun>DeployedApplicationHealth</command:noun> <maml:description> <maml:para>Sends a health report on the Service Fabric application deployed on a Service Fabric node.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Reports health state of the application deployed on a Service Fabric node. The report must contain the information about the source of the health report and property on which it is reported. The report is sent to a Service Fabric gateway Service, which forwards to the health store. The report may be accepted by the gateway, but rejected by the health store after extra validation. For example, the health store may reject the report because of an invalid parameter, like a stale sequence number. To see whether the report was applied in the health store, get deployed application health and check that the report appears in the HealthEvents section. </maml:para> </maml:description> <command:parameters> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="0"> <maml:name>NodeName</maml:name> <maml:Description> <maml:para> The name of the node. </maml:para> </maml:Description> <command:parameterValue required="true">NodeName</command:parameterValue> <dev:type> <maml:name>NodeName</maml:name> </dev:type> </command:parameter> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="1"> <maml:name>ApplicationId</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>SourceId</maml:name> <maml:Description> <maml:para> The source name that identifies the client/watchdog/system component that generated the health information. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="3"> <maml:name>Property</maml:name> <maml:Description> <maml:para> The property of the health information. An entity can have health reports for different properties. The property is a string and not a fixed enumeration to allow the reporter flexibility to categorize the state condition that triggers the report. For example, a reporter with SourceId "LocalWatchdog" can monitor the state of the available disk on a node, so it can report "AvailableDisk" property on that node. The same reporter can monitor the node connectivity, so it can report a property "Connectivity" on the same node. In the health store, these reports are treated as separate health events for the specified node. Together with the SourceId, the property uniquely identifies the health information. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="4"> <maml:name>HealthState</maml:name> <maml:Description> <maml:para> The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown' </maml:para> </maml:Description> <command:parameterValue required="true">HealthState?</command:parameterValue> <dev:type> <maml:name>HealthState?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>TimeToLiveInMilliSeconds</maml:name> <maml:Description> <maml:para> The duration for which this health report is valid. This field uses ISO8601 format for specifying the duration. 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. </maml:para> </maml:Description> <command:parameterValue required="false">TimeSpan?</command:parameterValue> <dev:type> <maml:name>TimeSpan?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>Description</maml:name> <maml:Description> <maml:para> The description of the health information. It represents free text used to add human readable information about the report. The maximum string length for the description is 4096 characters. If the provided string is longer, it will be automatically truncated. When truncated, the last characters of the description contain a marker "[Truncated]", and total string size is 4096 characters. The presence of the marker indicates to users that truncation occurred. Note that when truncated, the description has less than 4096 characters from the original string. </maml:para> </maml:Description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>SequenceNumber</maml:name> <maml:Description> <maml:para> The sequence number for this health report as a numeric string. 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. </maml:para> </maml:Description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>RemoveWhenExpired</maml:name> <maml:Description> <maml:para> Value that indicates whether the report is removed from health store when it expires. 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, if 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. </maml:para> </maml:Description> <command:parameterValue required="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>Immediate</maml:name> <maml:Description> <maml:para> A flag that indicates whether the report should be sent immediately. A health report is sent to a Service Fabric gateway Application, which forwards to the health store. If Immediate is set to true, the report is sent immediately from HTTP Gateway to the health store, regardless of the fabric client settings that the HTTP Gateway Application is using. This is useful for critical reports that should be sent as soon as possible. Depending on timing and other conditions, sending the report may still fail, for example if the HTTP Gateway is closed or the message doesn't reach the Gateway. If Immediate is set to false, the report is sent based on the health client settings from the HTTP Gateway. Therefore, it will be batched according to the HealthReportSendInterval configuration. This is the recommended setting because it allows the health client to optimize health reporting messages to health store as well as health report processing. By default, reports are not sent immediately. </maml:para> </maml:Description> <command:parameterValue required="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-SFService</command:name> <command:verb>Get</command:verb> <command:noun>Service</command:noun> <maml:description> <maml:para>Gets the information about all services belonging to the application specified by the application ID.</maml:para> </maml:description> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-SFService</maml:name> <command:parameter required="true"> <maml:name>ApplicationId</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>ServiceTypeName</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>ServerTimeout</maml:name> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-SFService</maml:name> <command:parameter required="true"> <maml:name>ApplicationId</maml:name> </command:parameter> <command:parameter required="true"> <maml:name>ServiceId</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>ServerTimeout</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <maml:description> <maml:para>Returns the information about all services belonging to the application specified by the application ID.</maml:para> </maml:description> <command:parameters> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="0"> <maml:name>ApplicationId</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="1"> <maml:name>ServiceId</maml:name> <maml:Description> <maml:para> The identity of the service. This ID is typically the full name of the service without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the service name is "fabric:/myapp/app1/svc1", the service identity would be "myapp~app1~svc1" in 6.0+ and "myapp/app1/svc1" in previous versions. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ServiceTypeName</maml:name> <maml:Description> <maml:para> The service type name used to filter the services to query for. </maml:para> </maml:Description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-SFApplicationNameInfo</command:name> <command:verb>Get</command:verb> <command:noun>ApplicationNameInfo</command:noun> <maml:description> <maml:para>Gets the name of the Service Fabric application for a service.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Gets the name of the application for the specified service. A 404 FABRIC_E_SERVICE_DOES_NOT_EXIST error is returned if a service with the provided service ID does not exist.</maml:para> </maml:description> <command:parameters> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="0"> <maml:name>ServiceId</maml:name> <maml:Description> <maml:para> The identity of the service. This ID is typically the full name of the service without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the service name is "fabric:/myapp/app1/svc1", the service identity would be "myapp~app1~svc1" in 6.0+ and "myapp/app1/svc1" in previous versions. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-SFService</command:name> <command:verb>New</command:verb> <command:noun>Service</command:noun> <maml:description> <maml:para>Creates the specified Service Fabric service.</maml:para> </maml:description> </command:details> <command:syntax> <command:syntaxItem> <maml:name>New-SFService</maml:name> <command:parameter required="true"> <maml:name>Count</maml:name> </command:parameter> <command:parameter required="true"> <maml:name>Names</maml:name> </command:parameter> <command:parameter required="true"> <maml:name>TargetReplicaSetSize</maml:name> </command:parameter> <command:parameter required="true"> <maml:name>MinReplicaSetSize</maml:name> </command:parameter> <command:parameter required="true"> <maml:name>HasPersistedState</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>Flags</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>ReplicaRestartWaitDurationSeconds</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>QuorumLossWaitDurationSeconds</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>StandByReplicaKeepDurationSeconds</maml:name> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-SFService</maml:name> <command:parameter required="true"> <maml:name>Count</maml:name> </command:parameter> <command:parameter required="true"> <maml:name>Names</maml:name> </command:parameter> <command:parameter required="true"> <maml:name>InstanceCount</maml:name> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-SFService</maml:name> <command:parameter required="true"> <maml:name>Count</maml:name> </command:parameter> <command:parameter required="true"> <maml:name>LowKey</maml:name> </command:parameter> <command:parameter required="true"> <maml:name>HighKey</maml:name> </command:parameter> <command:parameter required="true"> <maml:name>TargetReplicaSetSize</maml:name> </command:parameter> <command:parameter required="true"> <maml:name>MinReplicaSetSize</maml:name> </command:parameter> <command:parameter required="true"> <maml:name>HasPersistedState</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>Flags</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>ReplicaRestartWaitDurationSeconds</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>QuorumLossWaitDurationSeconds</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>StandByReplicaKeepDurationSeconds</maml:name> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-SFService</maml:name> <command:parameter required="true"> <maml:name>Count</maml:name> </command:parameter> <command:parameter required="true"> <maml:name>LowKey</maml:name> </command:parameter> <command:parameter required="true"> <maml:name>HighKey</maml:name> </command:parameter> <command:parameter required="true"> <maml:name>InstanceCount</maml:name> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-SFService</maml:name> <command:parameter required="true"> <maml:name>TargetReplicaSetSize</maml:name> </command:parameter> <command:parameter required="true"> <maml:name>MinReplicaSetSize</maml:name> </command:parameter> <command:parameter required="true"> <maml:name>HasPersistedState</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>Flags</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>ReplicaRestartWaitDurationSeconds</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>QuorumLossWaitDurationSeconds</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>StandByReplicaKeepDurationSeconds</maml:name> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-SFService</maml:name> <command:parameter required="true"> <maml:name>InstanceCount</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <maml:description> <maml:para>This api allows creating a new Service Fabric stateless or stateful service under a specified Service Fabric application. The description for creating the service includes partitioning information and optional properties for placement and load balancing. Some of the properties can later be modified using `UpdateService` API.</maml:para> </maml:description> <command:parameters> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="0"> <maml:name>ApplicationId</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>ServiceName</maml:name> <maml:Description> <maml:para> The full name of the service with 'fabric:' URI scheme. </maml:para> </maml:Description> <command:parameterValue required="true">ServiceName</command:parameterValue> <dev:type> <maml:name>ServiceName</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>ServiceTypeName</maml:name> <maml:Description> <maml:para> Name of the service type as specified in the service manifest. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="3"> <maml:name>Count</maml:name> <maml:Description> <maml:para> The number of partitions. </maml:para> </maml:Description> <command:parameterValue required="true">int?</command:parameterValue> <dev:type> <maml:name>int?</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="4"> <maml:name>Names</maml:name> <maml:Description> <maml:para> Array of size specified by the ‘Count’ parameter, for the names of the partitions. </maml:para> </maml:Description> <command:parameterValue required="true">IEnumerable<string></command:parameterValue> <dev:type> <maml:name>IEnumerable<string></maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="5"> <maml:name>LowKey</maml:name> <maml:Description> <maml:para> String indicating the lower bound of the partition key range that should be split between the partitions. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="6"> <maml:name>HighKey</maml:name> <maml:Description> <maml:para> String indicating the upper bound of the partition key range that should be split between the partitions. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="7"> <maml:name>TargetReplicaSetSize</maml:name> <maml:Description> <maml:para> The target replica set size as a number. </maml:para> </maml:Description> <command:parameterValue required="true">int?</command:parameterValue> <dev:type> <maml:name>int?</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="8"> <maml:name>MinReplicaSetSize</maml:name> <maml:Description> <maml:para> The minimum replica set size as a number. </maml:para> </maml:Description> <command:parameterValue required="true">int?</command:parameterValue> <dev:type> <maml:name>int?</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="9"> <maml:name>HasPersistedState</maml:name> <maml:Description> <maml:para> A flag indicating whether this is a persistent service which stores states on the local disk. If it is then the value of this property is true, if not it is false. </maml:para> </maml:Description> <command:parameterValue required="true">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="10"> <maml:name>InstanceCount</maml:name> <maml:Description> <maml:para> The instance count. </maml:para> </maml:Description> <command:parameterValue required="true">int?</command:parameterValue> <dev:type> <maml:name>int?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>ApplicationName</maml:name> <maml:Description> <maml:para> The name of the application, including the 'fabric:' URI scheme. </maml:para> </maml:Description> <command:parameterValue required="false">ApplicationName</command:parameterValue> <dev:type> <maml:name>ApplicationName</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>InitializationData</maml:name> <maml:Description> <maml:para> The initialization data as an array of bytes. Initialization data is passed to service instances or replicas when they are created. </maml:para> </maml:Description> <command:parameterValue required="false">byte[]</command:parameterValue> <dev:type> <maml:name>byte[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>PlacementConstraints</maml:name> <maml:Description> <maml:para> The placement constraints as a string. Placement constraints are boolean expressions on node properties and allow for restricting a service to particular nodes based on the service requirements. For example, to place a service on nodes where NodeType is blue specify the following: "NodeColor == blue)". </maml:para> </maml:Description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>CorrelationScheme</maml:name> <maml:Description> <maml:para> The correlation scheme. </maml:para> </maml:Description> <command:parameterValue required="false">IEnumerable<ServiceCorrelationDescription></command:parameterValue> <dev:type> <maml:name>IEnumerable<ServiceCorrelationDescription></maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>ServiceLoadMetrics</maml:name> <maml:Description> <maml:para> The service load metrics. </maml:para> </maml:Description> <command:parameterValue required="false">IEnumerable<ServiceLoadMetricDescription></command:parameterValue> <dev:type> <maml:name>IEnumerable<ServiceLoadMetricDescription></maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>ServicePlacementPolicies</maml:name> <maml:Description> <maml:para> The service placement policies. </maml:para> </maml:Description> <command:parameterValue required="false">IEnumerable<ServicePlacementPolicyDescription></command:parameterValue> <dev:type> <maml:name>IEnumerable<ServicePlacementPolicyDescription></maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>DefaultMoveCost</maml:name> <maml:Description> <maml:para> The move cost for the service. Possible values include: 'Zero', 'Low', 'Medium', 'High' Specifies the move cost for the service. </maml:para> </maml:Description> <command:parameterValue required="false">MoveCost?</command:parameterValue> <dev:type> <maml:name>MoveCost?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>IsDefaultMoveCostSpecified</maml:name> <maml:Description> <maml:para> Indicates if the DefaultMoveCost property is specified. </maml:para> </maml:Description> <command:parameterValue required="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>ServicePackageActivationMode</maml:name> <maml:Description> <maml:para> The activation mode of service package to be used for a service. Possible values include: 'SharedProcess', 'ExclusiveProcess' The activation mode of service package to be used for a Service Fabric service. This is specified at the time of creating the Service. </maml:para> </maml:Description> <command:parameterValue required="false">ServicePackageActivationMode?</command:parameterValue> <dev:type> <maml:name>ServicePackageActivationMode?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>ServiceDnsName</maml:name> <maml:Description> <maml:para> The DNS name of the service. It requires the DNS system service to be enabled in Service Fabric cluster. </maml:para> </maml:Description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>ScalingPolicies</maml:name> <maml:Description> <maml:para> Scaling policies for this service. </maml:para> </maml:Description> <command:parameterValue required="false">IEnumerable<ScalingPolicyDescription></command:parameterValue> <dev:type> <maml:name>IEnumerable<ScalingPolicyDescription></maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>Flags</maml:name> <maml:Description> <maml:para> Flags indicating whether other properties are set. Each of the associated properties corresponds to a flag, specified below, which, if set, indicate that the property is specified. This property can be a combination of those flags obtained using bitwise 'OR' operator. For example, if the provided value is 6 then the flags for QuorumLossWaitDuration (2) and StandByReplicaKeepDuration(4) are set. - None - Does not indicate any other properties are set. The value is zero. - ReplicaRestartWaitDuration - Indicates the ReplicaRestartWaitDuration property is set. The value is 1. - QuorumLossWaitDuration - Indicates the QuorumLossWaitDuration property is set. The value is 2. - StandByReplicaKeepDuration - Indicates the StandByReplicaKeepDuration property is set. The value is 4. </maml:para> </maml:Description> <command:parameterValue required="false">int?</command:parameterValue> <dev:type> <maml:name>int?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="23"> <maml:name>ReplicaRestartWaitDurationSeconds</maml:name> <maml:Description> <maml:para> The duration, in seconds, between when a replica goes down and when a new replica is created. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="24"> <maml:name>QuorumLossWaitDurationSeconds</maml:name> <maml:Description> <maml:para> The maximum duration, in seconds, for which a partition is allowed to be in a state of quorum loss. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="25"> <maml:name>StandByReplicaKeepDurationSeconds</maml:name> <maml:Description> <maml:para> The definition on how long StandBy replicas should be maintained before being removed. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="26"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-SFServiceFromTemplate</command:name> <command:verb>New</command:verb> <command:noun>ServiceFromTemplate</command:noun> <maml:description> <maml:para>Creates a Service Fabric service from the service template.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Creates a Service Fabric service from the service template defined in the application manifest. A service template contains the properties that will be same for the service instance of the same type. The API allows overriding the properties that are usually different for different services of the same service type.</maml:para> </maml:description> <command:parameters> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="0"> <maml:name>ApplicationId</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>ApplicationName</maml:name> <maml:Description> <maml:para> The name of the application, including the 'fabric:' URI scheme. </maml:para> </maml:Description> <command:parameterValue required="true">ApplicationName</command:parameterValue> <dev:type> <maml:name>ApplicationName</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>ServiceName</maml:name> <maml:Description> <maml:para> The full name of the service with 'fabric:' URI scheme. </maml:para> </maml:Description> <command:parameterValue required="true">ServiceName</command:parameterValue> <dev:type> <maml:name>ServiceName</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="3"> <maml:name>ServiceTypeName</maml:name> <maml:Description> <maml:para> Name of the service type as specified in the service manifest. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>InitializationData</maml:name> <maml:Description> <maml:para> The initialization data for the newly created service instance. </maml:para> </maml:Description> <command:parameterValue required="false">byte[]</command:parameterValue> <dev:type> <maml:name>byte[]</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>ServicePackageActivationMode</maml:name> <maml:Description> <maml:para> The activation mode of service package to be used for a service. Possible values include: 'SharedProcess', 'ExclusiveProcess' The activation mode of service package to be used for a Service Fabric service. This is specified at the time of creating the Service. </maml:para> </maml:Description> <command:parameterValue required="false">ServicePackageActivationMode?</command:parameterValue> <dev:type> <maml:name>ServicePackageActivationMode?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>ServiceDnsName</maml:name> <maml:Description> <maml:para> The DNS name of the service. It requires the DNS system service to be enabled in Service Fabric cluster. </maml:para> </maml:Description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-SFService</command:name> <command:verb>Remove</command:verb> <command:noun>Service</command:noun> <maml:description> <maml:para>Deletes an existing Service Fabric service.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>A service must be created before it can be deleted. By default, Service Fabric will try to close service replicas in a graceful manner and then delete the service. However, if the service is having issues closing the replica gracefully, the delete operation may take a long time or get stuck. Use the optional ForceRemove flag to skip the graceful close sequence and forcefully delete the service.</maml:para> </maml:description> <command:parameters> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="0"> <maml:name>ServiceId</maml:name> <maml:Description> <maml:para> The identity of the service. This ID is typically the full name of the service without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the service name is "fabric:/myapp/app1/svc1", the service identity would be "myapp~app1~svc1" in 6.0+ and "myapp/app1/svc1" in previous versions. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ForceRemove</maml:name> <maml:Description> <maml:para> Remove a Service Fabric application or service forcefully without going through the graceful shutdown sequence. This parameter can be used to forcefully delete an application or service for which delete is timing out due to issues in the service code that prevents graceful close of replicas. </maml:para> </maml:Description> <command:parameterValue required="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Update-SFService</command:name> <command:verb>Update</command:verb> <command:noun>Service</command:noun> <maml:description> <maml:para>Updates a Service Fabric service using the specified update description.</maml:para> </maml:description> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Update-SFService</maml:name> <command:parameter required="false"> <maml:name>TargetReplicaSetSize</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>MinReplicaSetSize</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>ReplicaRestartWaitDurationSeconds</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>QuorumLossWaitDurationSeconds</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>StandByReplicaKeepDurationSeconds</maml:name> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Update-SFService</maml:name> <command:parameter required="false"> <maml:name>InstanceCount</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <maml:description> <maml:para>This API allows updating properties of a running Service Fabric service. The set of properties that can be updated are a subset of the properties that were specified at the time of creating the service. The current set of properties can be obtained using `GetServiceDescription` API. Note that updating the properties of a running service is different than upgrading your application using `StartApplicationUpgrade` API. The upgrade is a long running background operation that involves moving the application from one version to another, one upgrade domain at a time, whereas update applies the new properties immediately to the service.</maml:para> </maml:description> <command:parameters> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="0"> <maml:name>ServiceId</maml:name> <maml:Description> <maml:para> The identity of the service. This ID is typically the full name of the service without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the service name is "fabric:/myapp/app1/svc1", the service identity would be "myapp~app1~svc1" in 6.0+ and "myapp/app1/svc1" in previous versions. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Flags</maml:name> <maml:Description> <maml:para> Flags indicating whether other properties are set. Each of the associated properties corresponds to a flag, specified below, which, if set, indicate that the property is specified. This property can be a combination of those flags obtained using bitwise 'OR' operator. For example, if the provided value is 6 then the flags for ReplicaRestartWaitDuration (2) and QuorumLossWaitDuration (4) are set. - None - Does not indicate any other properties are set. The value is zero. - TargetReplicaSetSize/InstanceCount - Indicates whether the TargetReplicaSetSize property (for Stateful services) or the InstanceCount property (for Stateless services) is set. The value is 1. - ReplicaRestartWaitDuration - Indicates the ReplicaRestartWaitDuration property is set. The value is 2. - QuorumLossWaitDuration - Indicates the QuorumLossWaitDuration property is set. The value is 4. - StandByReplicaKeepDuration - Indicates the StandByReplicaKeepDuration property is set. The value is 8. - MinReplicaSetSize - Indicates the MinReplicaSetSize property is set. The value is 16. - PlacementConstraints - Indicates the PlacementConstraints property is set. The value is 32. - PlacementPolicyList - Indicates the ServicePlacementPolicies property is set. The value is 64. - Correlation - Indicates the CorrelationScheme property is set. The value is 128. - Metrics - Indicates the ServiceLoadMetrics property is set. The value is 256. - DefaultMoveCost - Indicates the DefaultMoveCost property is set. The value is 512. - ScalingPolicy - Indicates the ScalingPolicies property is set. The value is 1024. </maml:para> </maml:Description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>PlacementConstraints</maml:name> <maml:Description> <maml:para> The placement constraints as a string. Placement constraints are boolean expressions on node properties and allow for restricting a service to particular nodes based on the service requirements. For example, to place a service on nodes where NodeType is blue specify the following: "NodeColor == blue)". </maml:para> </maml:Description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>CorrelationScheme</maml:name> <maml:Description> <maml:para> The correlation scheme. </maml:para> </maml:Description> <command:parameterValue required="false">IEnumerable<ServiceCorrelationDescription></command:parameterValue> <dev:type> <maml:name>IEnumerable<ServiceCorrelationDescription></maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>LoadMetrics</maml:name> <maml:Description> <maml:para> The service load metrics. </maml:para> </maml:Description> <command:parameterValue required="false">IEnumerable<ServiceLoadMetricDescription></command:parameterValue> <dev:type> <maml:name>IEnumerable<ServiceLoadMetricDescription></maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>ServicePlacementPolicies</maml:name> <maml:Description> <maml:para> The service placement policies. </maml:para> </maml:Description> <command:parameterValue required="false">IEnumerable<ServicePlacementPolicyDescription></command:parameterValue> <dev:type> <maml:name>IEnumerable<ServicePlacementPolicyDescription></maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>DefaultMoveCost</maml:name> <maml:Description> <maml:para> The move cost for the service. Possible values include: 'Zero', 'Low', 'Medium', 'High' Specifies the move cost for the service. </maml:para> </maml:Description> <command:parameterValue required="false">MoveCost?</command:parameterValue> <dev:type> <maml:name>MoveCost?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>ScalingPolicies</maml:name> <maml:Description> <maml:para> Scaling policies for this service. </maml:para> </maml:Description> <command:parameterValue required="false">IEnumerable<ScalingPolicyDescription></command:parameterValue> <dev:type> <maml:name>IEnumerable<ScalingPolicyDescription></maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>TargetReplicaSetSize</maml:name> <maml:Description> <maml:para> The target replica set size as a number. </maml:para> </maml:Description> <command:parameterValue required="false">int?</command:parameterValue> <dev:type> <maml:name>int?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>MinReplicaSetSize</maml:name> <maml:Description> <maml:para> The minimum replica set size as a number. </maml:para> </maml:Description> <command:parameterValue required="false">int?</command:parameterValue> <dev:type> <maml:name>int?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>ReplicaRestartWaitDurationSeconds</maml:name> <maml:Description> <maml:para> The duration, in seconds, between when a replica goes down and when a new replica is created. </maml:para> </maml:Description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>QuorumLossWaitDurationSeconds</maml:name> <maml:Description> <maml:para> The maximum duration, in seconds, for which a partition is allowed to be in a state of quorum loss. </maml:para> </maml:Description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>StandByReplicaKeepDurationSeconds</maml:name> <maml:Description> <maml:para> The definition on how long StandBy replicas should be maintained before being removed. </maml:para> </maml:Description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>InstanceCount</maml:name> <maml:Description> <maml:para> The instance count. </maml:para> </maml:Description> <command:parameterValue required="false">int?</command:parameterValue> <dev:type> <maml:name>int?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-SFServiceDescription</command:name> <command:verb>Get</command:verb> <command:noun>ServiceDescription</command:noun> <maml:description> <maml:para>Gets the description of an existing Service Fabric service.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Gets the description of an existing Service Fabric service. A service must be created before its description can be obtained.</maml:para> </maml:description> <command:parameters> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="0"> <maml:name>ServiceId</maml:name> <maml:Description> <maml:para> The identity of the service. This ID is typically the full name of the service without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the service name is "fabric:/myapp/app1/svc1", the service identity would be "myapp~app1~svc1" in 6.0+ and "myapp/app1/svc1" in previous versions. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-SFServiceHealth</command:name> <command:verb>Get</command:verb> <command:noun>ServiceHealth</command:noun> <maml:description> <maml:para>Gets the health of the specified Service Fabric service.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Gets the health information of the specified service. Use EventsHealthStateFilter to filter the collection of health events reported on the service based on the health state. Use PartitionsHealthStateFilter to filter the collection of partitions returned. If you specify a service that does not exist in the health store, this request returns an error. </maml:para> </maml:description> <command:parameters> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="0"> <maml:name>ServiceId</maml:name> <maml:Description> <maml:para> The identity of the service. This ID is typically the full name of the service without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the service name is "fabric:/myapp/app1/svc1", the service identity would be "myapp~app1~svc1" in 6.0+ and "myapp/app1/svc1" in previous versions. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>EventsHealthStateFilter</maml:name> <maml:Description> <maml:para> 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. - Default - Default value. Matches any HealthState. The value is zero. - 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. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - Error - Filter that matches input with HealthState value Error. The value is 8. - All - Filter that matches input with any HealthState value. The value is 65535. </maml:para> </maml:Description> <command:parameterValue required="false">int?</command:parameterValue> <dev:type> <maml:name>int?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>PartitionsHealthStateFilter</maml:name> <maml:Description> <maml:para> Allows filtering of the partitions health state objects returned in the result of service health query based on their health state. The possible values for this parameter include integer value of one of the following health states. Only partitions that match the filter are returned. All partitions 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 value obtained using bitwise 'OR' operator. For example, if the provided value is 6 then health state of partitions with HealthState value of OK (2) and Warning (4) will be returned. - Default - Default value. Matches any HealthState. The value is zero. - 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. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - Error - Filter that matches input with HealthState value Error. The value is 8. - All - Filter that matches input with any HealthState value. The value is 65535. </maml:para> </maml:Description> <command:parameterValue required="false">int?</command:parameterValue> <dev:type> <maml:name>int?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>ExcludeHealthStatistics</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-SFServiceHealthUsingPolicy</command:name> <command:verb>Get</command:verb> <command:noun>ServiceHealthUsingPolicy</command:noun> <maml:description> <maml:para>Gets the health of the specified Service Fabric service, by using the specified health policy.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Gets the health information of the specified service. If the application health policy is specified, the health evaluation uses it to get the aggregated health state. If the policy is not specified, the health evaluation uses the application health policy defined in the application manifest, or the default health policy, if no policy is defined in the manifest. Use EventsHealthStateFilter to filter the collection of health events reported on the service based on the health state. Use PartitionsHealthStateFilter to filter the collection of partitions returned. If you specify a service that does not exist in the health store, this request returns an error. </maml:para> </maml:description> <command:parameters> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="0"> <maml:name>ServiceId</maml:name> <maml:Description> <maml:para> The identity of the service. This ID is typically the full name of the service without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the service name is "fabric:/myapp/app1/svc1", the service identity would be "myapp~app1~svc1" in 6.0+ and "myapp/app1/svc1" in previous versions. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>EventsHealthStateFilter</maml:name> <maml:Description> <maml:para> 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. - Default - Default value. Matches any HealthState. The value is zero. - 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. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - Error - Filter that matches input with HealthState value Error. The value is 8. - All - Filter that matches input with any HealthState value. The value is 65535. </maml:para> </maml:Description> <command:parameterValue required="false">int?</command:parameterValue> <dev:type> <maml:name>int?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>PartitionsHealthStateFilter</maml:name> <maml:Description> <maml:para> Allows filtering of the partitions health state objects returned in the result of service health query based on their health state. The possible values for this parameter include integer value of one of the following health states. Only partitions that match the filter are returned. All partitions 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 value obtained using bitwise 'OR' operator. For example, if the provided value is 6 then health state of partitions with HealthState value of OK (2) and Warning (4) will be returned. - Default - Default value. Matches any HealthState. The value is zero. - 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. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - Error - Filter that matches input with HealthState value Error. The value is 8. - All - Filter that matches input with any HealthState value. The value is 65535. </maml:para> </maml:Description> <command:parameterValue required="false">int?</command:parameterValue> <dev:type> <maml:name>int?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>ConsiderWarningAsError</maml:name> <maml:Description> <maml:para> Indicates whether warnings are treated with the same severity as errors. </maml:para> </maml:Description> <command:parameterValue required="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>MaxPercentUnhealthyDeployedApplications</maml:name> <maml:Description> <maml:para> The maximum allowed percentage of unhealthy deployed applications. Allowed values are Byte values from zero to 100. The percentage represents the maximum tolerated percentage of deployed applications that can be unhealthy before the application is considered in error. This is calculated by dividing the number of unhealthy deployed applications over the number of nodes where the application is currently deployed on in the cluster. The computation rounds up to tolerate one failure on small numbers of nodes. Default percentage is zero. </maml:para> </maml:Description> <command:parameterValue required="false">int?</command:parameterValue> <dev:type> <maml:name>int?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>MaxPercentUnhealthyPartitionsPerService</maml:name> <maml:Description> <maml:para> The maximum allowed percentage of unhealthy partitions per service. Allowed values are Byte values from zero to 100 The percentage represents the maximum tolerated percentage of partitions that can be unhealthy before the service is considered in error. If the percentage is respected but there is at least one unhealthy partition, the health is evaluated as Warning. The percentage is calculated by dividing the number of unhealthy partitions over the total number of partitions in the service. The computation rounds up to tolerate one failure on small numbers of partitions. Default percentage is zero. </maml:para> </maml:Description> <command:parameterValue required="false">int?</command:parameterValue> <dev:type> <maml:name>int?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>MaxPercentUnhealthyReplicasPerPartition</maml:name> <maml:Description> <maml:para> The maximum allowed percentage of unhealthy replicas per partition. Allowed values are Byte values from zero to 100. The percentage represents the maximum tolerated percentage of replicas that can be unhealthy before the partition is considered in error. If the percentage is respected but there is at least one unhealthy replica, the health is evaluated as Warning. The percentage is calculated by dividing the number of unhealthy replicas over the total number of replicas in the partition. The computation rounds up to tolerate one failure on small numbers of replicas. Default percentage is zero. </maml:para> </maml:Description> <command:parameterValue required="false">int?</command:parameterValue> <dev:type> <maml:name>int?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>MaxPercentUnhealthyServices</maml:name> <maml:Description> <maml:para> The maximum allowed percentage of unhealthy services. Allowed values are Byte values from zero to 100. The percentage represents the maximum tolerated percentage of services that can be unhealthy before the application is considered in error. If the percentage is respected but there is at least one unhealthy service, the health is evaluated as Warning. This is calculated by dividing the number of unhealthy services of the specific service type over the total number of services of the specific service type. The computation rounds up to tolerate one failure on small numbers of services. Default percentage is zero. </maml:para> </maml:Description> <command:parameterValue required="false">int?</command:parameterValue> <dev:type> <maml:name>int?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>ServiceTypeHealthPolicyMap</maml:name> <maml:Description> <maml:para> The map with service type health policy per service type name. The map is empty by default. </maml:para> </maml:Description> <command:parameterValue required="false">IEnumerable<ServiceTypeHealthPolicyMapItem></command:parameterValue> <dev:type> <maml:name>IEnumerable<ServiceTypeHealthPolicyMapItem></maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>ExcludeHealthStatistics</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-SFServiceHealth</command:name> <command:verb>New</command:verb> <command:noun>ServiceHealth</command:noun> <maml:description> <maml:para>Sends a health report on the Service Fabric service.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Reports health state of the specified Service Fabric service. The report must contain the information about the source of the health report and property on which it is reported. The report is sent to a Service Fabric gateway Service, which forwards to the health store. The report may be accepted by the gateway, but rejected by the health store after extra validation. For example, the health store may reject the report because of an invalid parameter, like a stale sequence number. To see whether the report was applied in the health store, run GetServiceHealth and check that the report appears in the HealthEvents section. </maml:para> </maml:description> <command:parameters> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="0"> <maml:name>ServiceId</maml:name> <maml:Description> <maml:para> The identity of the service. This ID is typically the full name of the service without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the service name is "fabric:/myapp/app1/svc1", the service identity would be "myapp~app1~svc1" in 6.0+ and "myapp/app1/svc1" in previous versions. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>SourceId</maml:name> <maml:Description> <maml:para> The source name that identifies the client/watchdog/system component that generated the health information. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Property</maml:name> <maml:Description> <maml:para> The property of the health information. An entity can have health reports for different properties. The property is a string and not a fixed enumeration to allow the reporter flexibility to categorize the state condition that triggers the report. For example, a reporter with SourceId "LocalWatchdog" can monitor the state of the available disk on a node, so it can report "AvailableDisk" property on that node. The same reporter can monitor the node connectivity, so it can report a property "Connectivity" on the same node. In the health store, these reports are treated as separate health events for the specified node. Together with the SourceId, the property uniquely identifies the health information. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="3"> <maml:name>HealthState</maml:name> <maml:Description> <maml:para> The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown' </maml:para> </maml:Description> <command:parameterValue required="true">HealthState?</command:parameterValue> <dev:type> <maml:name>HealthState?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>TimeToLiveInMilliSeconds</maml:name> <maml:Description> <maml:para> The duration for which this health report is valid. This field uses ISO8601 format for specifying the duration. 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. </maml:para> </maml:Description> <command:parameterValue required="false">TimeSpan?</command:parameterValue> <dev:type> <maml:name>TimeSpan?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>Description</maml:name> <maml:Description> <maml:para> The description of the health information. It represents free text used to add human readable information about the report. The maximum string length for the description is 4096 characters. If the provided string is longer, it will be automatically truncated. When truncated, the last characters of the description contain a marker "[Truncated]", and total string size is 4096 characters. The presence of the marker indicates to users that truncation occurred. Note that when truncated, the description has less than 4096 characters from the original string. </maml:para> </maml:Description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>SequenceNumber</maml:name> <maml:Description> <maml:para> The sequence number for this health report as a numeric string. 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. </maml:para> </maml:Description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>RemoveWhenExpired</maml:name> <maml:Description> <maml:para> Value that indicates whether the report is removed from health store when it expires. 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, if 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. </maml:para> </maml:Description> <command:parameterValue required="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Immediate</maml:name> <maml:Description> <maml:para> A flag that indicates whether the report should be sent immediately. A health report is sent to a Service Fabric gateway Application, which forwards to the health store. If Immediate is set to true, the report is sent immediately from HTTP Gateway to the health store, regardless of the fabric client settings that the HTTP Gateway Application is using. This is useful for critical reports that should be sent as soon as possible. Depending on timing and other conditions, sending the report may still fail, for example if the HTTP Gateway is closed or the message doesn't reach the Gateway. If Immediate is set to false, the report is sent based on the health client settings from the HTTP Gateway. Therefore, it will be batched according to the HealthReportSendInterval configuration. This is the recommended setting because it allows the health client to optimize health reporting messages to health store as well as health report processing. By default, reports are not sent immediately. </maml:para> </maml:Description> <command:parameterValue required="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Resolve-SFService</command:name> <command:verb>Resolve</command:verb> <command:noun>Service</command:noun> <maml:description> <maml:para>Resolve a Service Fabric partition.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Resolve a Service Fabric service partition to get the endpoints of the service replicas.</maml:para> </maml:description> <command:parameters> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="0"> <maml:name>ServiceId</maml:name> <maml:Description> <maml:para> The identity of the service. This ID is typically the full name of the service without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the service name is "fabric:/myapp/app1/svc1", the service identity would be "myapp~app1~svc1" in 6.0+ and "myapp/app1/svc1" in previous versions. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>PartitionKeyType</maml:name> <maml:Description> <maml:para> Key type for the partition. This parameter is required if the partition scheme for the service is Int64Range or Named. The possible values are following. - None (1) - Indicates that the PartitionKeyValue parameter is not specified. This is valid for the partitions with partitioning scheme as Singleton. This is the default value. The value is 1. - Int64Range (2) - Indicates that the PartitionKeyValue parameter is an int64 partition key. This is valid for the partitions with partitioning scheme as Int64Range. The value is 2. - Named (3) - Indicates that the PartitionKeyValue parameter is a name of the partition. This is valid for the partitions with partitioning scheme as Named. The value is 3. </maml:para> </maml:Description> <command:parameterValue required="false">int?</command:parameterValue> <dev:type> <maml:name>int?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>PartitionKeyValue</maml:name> <maml:Description> <maml:para> Partition key. This is required if the partition scheme for the service is Int64Range or Named. This is not the partition ID, but rather, either the integer key value, or the name of the partition ID. For example, if your service is using ranged partitions from 0 to 10, then they PartitionKeyValue would be an integer in that range. Query service description to see the range or name. </maml:para> </maml:Description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>PreviousRspVersion</maml:name> <maml:Description> <maml:para> The value in the Version field of the response that was received previously. This is required if the user knows that the result that was gotten previously is stale. </maml:para> </maml:Description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-SFUnplacedReplicaInformation</command:name> <command:verb>Get</command:verb> <command:noun>UnplacedReplicaInformation</command:noun> <maml:description> <maml:para>Gets the information about unplaced replica of the service.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Returns the information about the unplaced replicas of the service. If PartitionId is specified, then result will contain information only about unplaced replicas for that partition. If PartitionId is not specified, then result will contain information about unplaced replicas for all partitions of that service. If OnlyQueryPrimaries is set to true, then result will contain information only about primary replicas, and will ignore unplaced secondary replicas. </maml:para> </maml:description> <command:parameters> <command:parameter required="true" position="0"> <maml:name>ServiceId</maml:name> <maml:Description> <maml:para> The identity of the service. This ID is typically the full name of the service without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the service name is "fabric:/myapp/app1/svc1", the service identity would be "myapp~app1~svc1" in 6.0+ and "myapp/app1/svc1" in previous versions. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>PartitionId</maml:name> <maml:Description> <maml:para> The identity of the partition. </maml:para> </maml:Description> <command:parameterValue required="false">PartitionId</command:parameterValue> <dev:type> <maml:name>PartitionId</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>OnlyQueryPrimaries</maml:name> <maml:Description> <maml:para> Indicates that unplaced replica information will be queries only for primary replicas. </maml:para> </maml:Description> <command:parameterValue required="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-SFPartition</command:name> <command:verb>Get</command:verb> <command:noun>Partition</command:noun> <maml:description> <maml:para>Gets the list of partitions of a Service Fabric service.</maml:para> </maml:description> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-SFPartition</maml:name> <command:parameter required="true"> <maml:name>ServiceId</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>ServerTimeout</maml:name> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-SFPartition</maml:name> <command:parameter required="true"> <maml:name>PartitionId</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>ServerTimeout</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <maml:description> <maml:para>The response includes the partition ID, partitioning scheme information, keys supported by the partition, status, health, and other details about the partition.</maml:para> </maml:description> <command:parameters> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="0"> <maml:name>ServiceId</maml:name> <maml:Description> <maml:para> The identity of the service. This ID is typically the full name of the service without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the service name is "fabric:/myapp/app1/svc1", the service identity would be "myapp~app1~svc1" in 6.0+ and "myapp/app1/svc1" in previous versions. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="1"> <maml:name>PartitionId</maml:name> <maml:Description> <maml:para> The identity of the partition. </maml:para> </maml:Description> <command:parameterValue required="true">PartitionId</command:parameterValue> <dev:type> <maml:name>PartitionId</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-SFServiceNameInfo</command:name> <command:verb>Get</command:verb> <command:noun>ServiceNameInfo</command:noun> <maml:description> <maml:para>Gets the name of the Service Fabric service for a partition.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Gets name of the service for the specified partition. A 404 error is returned if the partition ID does not exist in the cluster.</maml:para> </maml:description> <command:parameters> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="0"> <maml:name>PartitionId</maml:name> <maml:Description> <maml:para> The identity of the partition. </maml:para> </maml:Description> <command:parameterValue required="true">PartitionId</command:parameterValue> <dev:type> <maml:name>PartitionId</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-SFPartitionHealth</command:name> <command:verb>Get</command:verb> <command:noun>PartitionHealth</command:noun> <maml:description> <maml:para>Gets the health of the specified Service Fabric partition.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Use EventsHealthStateFilter to filter the collection of health events reported on the service based on the health state. Use ReplicasHealthStateFilter to filter the collection of ReplicaHealthState objects on the partition. If you specify a partition that does not exist in the health store, this request returns an error. </maml:para> </maml:description> <command:parameters> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="0"> <maml:name>PartitionId</maml:name> <maml:Description> <maml:para> The identity of the partition. </maml:para> </maml:Description> <command:parameterValue required="true">PartitionId</command:parameterValue> <dev:type> <maml:name>PartitionId</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>EventsHealthStateFilter</maml:name> <maml:Description> <maml:para> 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. - Default - Default value. Matches any HealthState. The value is zero. - 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. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - Error - Filter that matches input with HealthState value Error. The value is 8. - All - Filter that matches input with any HealthState value. The value is 65535. </maml:para> </maml:Description> <command:parameterValue required="false">int?</command:parameterValue> <dev:type> <maml:name>int?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ReplicasHealthStateFilter</maml:name> <maml:Description> <maml:para> Allows filtering the collection of ReplicaHealthState objects on the partition. The value can be obtained from members or bitwise operations on members of HealthStateFilter. Only replicas that match the filter will be returned. All replicas will be used to evaluate the aggregated health state. If not specified, all entries will be 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 all of the events with HealthState value of OK (2) and Warning (4) will be returned. The possible values for this parameter include integer value of one of the following health states. - Default - Default value. Matches any HealthState. The value is zero. - 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. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - Error - Filter that matches input with HealthState value Error. The value is 8. - All - Filter that matches input with any HealthState value. The value is 65535. </maml:para> </maml:Description> <command:parameterValue required="false">int?</command:parameterValue> <dev:type> <maml:name>int?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>ExcludeHealthStatistics</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-SFPartitionHealthUsingPolicy</command:name> <command:verb>Get</command:verb> <command:noun>PartitionHealthUsingPolicy</command:noun> <maml:description> <maml:para>Gets the health of the specified Service Fabric partition, by using the specified health policy.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Gets the health information of the specified partition. If the application health policy is specified, the health evaluation uses it to get the aggregated health state. If the policy is not specified, the health evaluation uses the application health policy defined in the application manifest, or the default health policy, if no policy is defined in the manifest. Use EventsHealthStateFilter to filter the collection of health events reported on the partition based on the health state. Use ReplicasHealthStateFilter to filter the collection of ReplicaHealthState objects on the partition. Use ApplicationHealthPolicy in the POST body to override the health policies used to evaluate the health. If you specify a partition that does not exist in the health store, this request returns an error. </maml:para> </maml:description> <command:parameters> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="0"> <maml:name>PartitionId</maml:name> <maml:Description> <maml:para> The identity of the partition. </maml:para> </maml:Description> <command:parameterValue required="true">PartitionId</command:parameterValue> <dev:type> <maml:name>PartitionId</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>EventsHealthStateFilter</maml:name> <maml:Description> <maml:para> 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. - Default - Default value. Matches any HealthState. The value is zero. - 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. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - Error - Filter that matches input with HealthState value Error. The value is 8. - All - Filter that matches input with any HealthState value. The value is 65535. </maml:para> </maml:Description> <command:parameterValue required="false">int?</command:parameterValue> <dev:type> <maml:name>int?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ReplicasHealthStateFilter</maml:name> <maml:Description> <maml:para> Allows filtering the collection of ReplicaHealthState objects on the partition. The value can be obtained from members or bitwise operations on members of HealthStateFilter. Only replicas that match the filter will be returned. All replicas will be used to evaluate the aggregated health state. If not specified, all entries will be 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 all of the events with HealthState value of OK (2) and Warning (4) will be returned. The possible values for this parameter include integer value of one of the following health states. - Default - Default value. Matches any HealthState. The value is zero. - 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. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - Error - Filter that matches input with HealthState value Error. The value is 8. - All - Filter that matches input with any HealthState value. The value is 65535. </maml:para> </maml:Description> <command:parameterValue required="false">int?</command:parameterValue> <dev:type> <maml:name>int?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>ConsiderWarningAsError</maml:name> <maml:Description> <maml:para> Indicates whether warnings are treated with the same severity as errors. </maml:para> </maml:Description> <command:parameterValue required="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>MaxPercentUnhealthyDeployedApplications</maml:name> <maml:Description> <maml:para> The maximum allowed percentage of unhealthy deployed applications. Allowed values are Byte values from zero to 100. The percentage represents the maximum tolerated percentage of deployed applications that can be unhealthy before the application is considered in error. This is calculated by dividing the number of unhealthy deployed applications over the number of nodes where the application is currently deployed on in the cluster. The computation rounds up to tolerate one failure on small numbers of nodes. Default percentage is zero. </maml:para> </maml:Description> <command:parameterValue required="false">int?</command:parameterValue> <dev:type> <maml:name>int?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>MaxPercentUnhealthyPartitionsPerService</maml:name> <maml:Description> <maml:para> The maximum allowed percentage of unhealthy partitions per service. Allowed values are Byte values from zero to 100 The percentage represents the maximum tolerated percentage of partitions that can be unhealthy before the service is considered in error. If the percentage is respected but there is at least one unhealthy partition, the health is evaluated as Warning. The percentage is calculated by dividing the number of unhealthy partitions over the total number of partitions in the service. The computation rounds up to tolerate one failure on small numbers of partitions. Default percentage is zero. </maml:para> </maml:Description> <command:parameterValue required="false">int?</command:parameterValue> <dev:type> <maml:name>int?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>MaxPercentUnhealthyReplicasPerPartition</maml:name> <maml:Description> <maml:para> The maximum allowed percentage of unhealthy replicas per partition. Allowed values are Byte values from zero to 100. The percentage represents the maximum tolerated percentage of replicas that can be unhealthy before the partition is considered in error. If the percentage is respected but there is at least one unhealthy replica, the health is evaluated as Warning. The percentage is calculated by dividing the number of unhealthy replicas over the total number of replicas in the partition. The computation rounds up to tolerate one failure on small numbers of replicas. Default percentage is zero. </maml:para> </maml:Description> <command:parameterValue required="false">int?</command:parameterValue> <dev:type> <maml:name>int?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>MaxPercentUnhealthyServices</maml:name> <maml:Description> <maml:para> The maximum allowed percentage of unhealthy services. Allowed values are Byte values from zero to 100. The percentage represents the maximum tolerated percentage of services that can be unhealthy before the application is considered in error. If the percentage is respected but there is at least one unhealthy service, the health is evaluated as Warning. This is calculated by dividing the number of unhealthy services of the specific service type over the total number of services of the specific service type. The computation rounds up to tolerate one failure on small numbers of services. Default percentage is zero. </maml:para> </maml:Description> <command:parameterValue required="false">int?</command:parameterValue> <dev:type> <maml:name>int?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>ServiceTypeHealthPolicyMap</maml:name> <maml:Description> <maml:para> The map with service type health policy per service type name. The map is empty by default. </maml:para> </maml:Description> <command:parameterValue required="false">IEnumerable<ServiceTypeHealthPolicyMapItem></command:parameterValue> <dev:type> <maml:name>IEnumerable<ServiceTypeHealthPolicyMapItem></maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>ExcludeHealthStatistics</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-SFPartitionHealth</command:name> <command:verb>New</command:verb> <command:noun>PartitionHealth</command:noun> <maml:description> <maml:para>Sends a health report on the Service Fabric partition.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Reports health state of the specified Service Fabric partition. The report must contain the information about the source of the health report and property on which it is reported. The report is sent to a Service Fabric gateway Partition, which forwards to the health store. The report may be accepted by the gateway, but rejected by the health store after extra validation. For example, the health store may reject the report because of an invalid parameter, like a stale sequence number. To see whether the report was applied in the health store, run GetPartitionHealth and check that the report appears in the HealthEvents section. </maml:para> </maml:description> <command:parameters> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="0"> <maml:name>PartitionId</maml:name> <maml:Description> <maml:para> The identity of the partition. </maml:para> </maml:Description> <command:parameterValue required="true">PartitionId</command:parameterValue> <dev:type> <maml:name>PartitionId</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>SourceId</maml:name> <maml:Description> <maml:para> The source name that identifies the client/watchdog/system component that generated the health information. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Property</maml:name> <maml:Description> <maml:para> The property of the health information. An entity can have health reports for different properties. The property is a string and not a fixed enumeration to allow the reporter flexibility to categorize the state condition that triggers the report. For example, a reporter with SourceId "LocalWatchdog" can monitor the state of the available disk on a node, so it can report "AvailableDisk" property on that node. The same reporter can monitor the node connectivity, so it can report a property "Connectivity" on the same node. In the health store, these reports are treated as separate health events for the specified node. Together with the SourceId, the property uniquely identifies the health information. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="3"> <maml:name>HealthState</maml:name> <maml:Description> <maml:para> The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown' </maml:para> </maml:Description> <command:parameterValue required="true">HealthState?</command:parameterValue> <dev:type> <maml:name>HealthState?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>TimeToLiveInMilliSeconds</maml:name> <maml:Description> <maml:para> The duration for which this health report is valid. This field uses ISO8601 format for specifying the duration. 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. </maml:para> </maml:Description> <command:parameterValue required="false">TimeSpan?</command:parameterValue> <dev:type> <maml:name>TimeSpan?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>Description</maml:name> <maml:Description> <maml:para> The description of the health information. It represents free text used to add human readable information about the report. The maximum string length for the description is 4096 characters. If the provided string is longer, it will be automatically truncated. When truncated, the last characters of the description contain a marker "[Truncated]", and total string size is 4096 characters. The presence of the marker indicates to users that truncation occurred. Note that when truncated, the description has less than 4096 characters from the original string. </maml:para> </maml:Description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>SequenceNumber</maml:name> <maml:Description> <maml:para> The sequence number for this health report as a numeric string. 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. </maml:para> </maml:Description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>RemoveWhenExpired</maml:name> <maml:Description> <maml:para> Value that indicates whether the report is removed from health store when it expires. 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, if 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. </maml:para> </maml:Description> <command:parameterValue required="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Immediate</maml:name> <maml:Description> <maml:para> A flag that indicates whether the report should be sent immediately. A health report is sent to a Service Fabric gateway Application, which forwards to the health store. If Immediate is set to true, the report is sent immediately from HTTP Gateway to the health store, regardless of the fabric client settings that the HTTP Gateway Application is using. This is useful for critical reports that should be sent as soon as possible. Depending on timing and other conditions, sending the report may still fail, for example if the HTTP Gateway is closed or the message doesn't reach the Gateway. If Immediate is set to false, the report is sent based on the health client settings from the HTTP Gateway. Therefore, it will be batched according to the HealthReportSendInterval configuration. This is the recommended setting because it allows the health client to optimize health reporting messages to health store as well as health report processing. By default, reports are not sent immediately. </maml:para> </maml:Description> <command:parameterValue required="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-SFPartitionLoadInformation</command:name> <command:verb>Get</command:verb> <command:noun>PartitionLoadInformation</command:noun> <maml:description> <maml:para>Gets the load information of the specified Service Fabric partition.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Returns information about the load of a specified partition. The response includes a list of load reports for a Service Fabric partition. Each report includes the load metric name, value, and last reported time in UTC. </maml:para> </maml:description> <command:parameters> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="0"> <maml:name>PartitionId</maml:name> <maml:Description> <maml:para> The identity of the partition. </maml:para> </maml:Description> <command:parameterValue required="true">PartitionId</command:parameterValue> <dev:type> <maml:name>PartitionId</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Reset-SFPartitionLoad</command:name> <command:verb>Reset</command:verb> <command:noun>PartitionLoad</command:noun> <maml:description> <maml:para>Resets the current load of a Service Fabric partition.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Resets the current load of a Service Fabric partition to the default load for the service.</maml:para> </maml:description> <command:parameters> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="0"> <maml:name>PartitionId</maml:name> <maml:Description> <maml:para> The identity of the partition. </maml:para> </maml:Description> <command:parameterValue required="true">PartitionId</command:parameterValue> <dev:type> <maml:name>PartitionId</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Repair-SFPartition</command:name> <command:verb>Repair</command:verb> <command:noun>Partition</command:noun> <maml:description> <maml:para>Indicates to the Service Fabric cluster that it should attempt to recover a specific partition that is currently stuck in quorum loss.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>This operation should only be performed if it is known that the replicas that are down cannot be recovered. Incorrect use of this API can cause potential data loss.</maml:para> </maml:description> <command:parameters> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="0"> <maml:name>PartitionId</maml:name> <maml:Description> <maml:para> The identity of the partition. </maml:para> </maml:Description> <command:parameterValue required="true">PartitionId</command:parameterValue> <dev:type> <maml:name>PartitionId</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Repair-SFServicePartitions</command:name> <command:verb>Repair</command:verb> <command:noun>ServicePartitions</command:noun> <maml:description> <maml:para>Indicates to the Service Fabric cluster that it should attempt to recover the specified service that is currently stuck in quorum loss.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Indicates to the Service Fabric cluster that it should attempt to recover the specified service that is currently stuck in quorum loss. This operation should only be performed if it is known that the replicas that are down cannot be recovered. Incorrect use of this API can cause potential data loss.</maml:para> </maml:description> <command:parameters> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="0"> <maml:name>ServiceId</maml:name> <maml:Description> <maml:para> The identity of the service. This ID is typically the full name of the service without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the service name is "fabric:/myapp/app1/svc1", the service identity would be "myapp~app1~svc1" in 6.0+ and "myapp/app1/svc1" in previous versions. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Repair-SFSystemPartitions</command:name> <command:verb>Repair</command:verb> <command:noun>SystemPartitions</command:noun> <maml:description> <maml:para>Indicates to the Service Fabric cluster that it should attempt to recover the system services that are currently stuck in quorum loss.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Indicates to the Service Fabric cluster that it should attempt to recover the system services that are currently stuck in quorum loss. This operation should only be performed if it is known that the replicas that are down cannot be recovered. Incorrect use of this API can cause potential data loss.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Repair-SFAllPartitions</command:name> <command:verb>Repair</command:verb> <command:noun>AllPartitions</command:noun> <maml:description> <maml:para>Indicates to the Service Fabric cluster that it should attempt to recover any services (including system services) which are currently stuck in quorum loss.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>This operation should only be performed if it is known that the replicas that are down cannot be recovered. Incorrect use of this API can cause potential data loss.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Move-SFPrimaryReplica</command:name> <command:verb>Move</command:verb> <command:noun>PrimaryReplica</command:noun> <maml:description> <maml:para>Moves the primary replica of a partition of a stateful service.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>This command moves the primary replica of a partition of a stateful service, respecting all constraints. If NodeName parameter is specified, primary will be moved to the specified node (if constraints allow it). If NodeName parameter is not specified, primary replica will be moved to a random node in the cluster. If IgnoreConstraints parameter is specified and set to true, then primary will be moved regardless of the constraints. </maml:para> </maml:description> <command:parameters> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="0"> <maml:name>PartitionId</maml:name> <maml:Description> <maml:para> The identity of the partition. </maml:para> </maml:Description> <command:parameterValue required="true">PartitionId</command:parameterValue> <dev:type> <maml:name>PartitionId</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>NodeName</maml:name> <maml:Description> <maml:para> The name of the node. </maml:para> </maml:Description> <command:parameterValue required="false">NodeName</command:parameterValue> <dev:type> <maml:name>NodeName</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>IgnoreConstraints</maml:name> <maml:Description> <maml:para> Ignore constraints when moving a replica. If this parameter is not specified, all constraints are honored. </maml:para> </maml:Description> <command:parameterValue required="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Move-SFSecondaryReplica</command:name> <command:verb>Move</command:verb> <command:noun>SecondaryReplica</command:noun> <maml:description> <maml:para>Moves the secondary replica of a partition of a stateful service.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>This command moves the secondary replica of a partition of a stateful service, respecting all constraints. CurrentNodeName parameter must be specified to identify the replica that is moved. Source node name must be specified, but new node name can be omitted, and in that case replica is moved to a random node. If IgnoreConstraints parameter is specified and set to true, then secondary will be moved regardless of the constraints. </maml:para> </maml:description> <command:parameters> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="0"> <maml:name>PartitionId</maml:name> <maml:Description> <maml:para> The identity of the partition. </maml:para> </maml:Description> <command:parameterValue required="true">PartitionId</command:parameterValue> <dev:type> <maml:name>PartitionId</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>CurrentNodeName</maml:name> <maml:Description> <maml:para> The name of the source node for secondary replica move. </maml:para> </maml:Description> <command:parameterValue required="true">NodeName</command:parameterValue> <dev:type> <maml:name>NodeName</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>NewNodeName</maml:name> <maml:Description> <maml:para> The name of the target node for secondary replica move. If not specified, replica is moved to a random node. </maml:para> </maml:Description> <command:parameterValue required="false">NodeName</command:parameterValue> <dev:type> <maml:name>NodeName</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>IgnoreConstraints</maml:name> <maml:Description> <maml:para> Ignore constraints when moving a replica. If this parameter is not specified, all constraints are honored. </maml:para> </maml:Description> <command:parameterValue required="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-SFRepairTask</command:name> <command:verb>New</command:verb> <command:noun>RepairTask</command:noun> <maml:description> <maml:para>Creates a new repair task.</maml:para> </maml:description> </command:details> <command:syntax> <command:syntaxItem> <maml:name>New-SFRepairTask</maml:name> <command:parameter required="false"> <maml:name>NodeNames</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>NodeImpactList</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <maml:description> <maml:para>For clusters that have the Repair Manager Service configured, this API provides a way to create repair tasks that run automatically or manually. For repair tasks that run automatically, an appropriate repair executor must be running for each repair action to run automatically. These are currently only available in specially-configured Azure Cloud Services. To create a manual repair task, provide the set of impacted node names and the expected impact. When the state of the created repair task changes to approved, you can safely perform repair actions on those nodes. This API supports the Service Fabric platform; it is not meant to be used directly from your code. </maml:para> </maml:description> <command:parameters> <command:parameter required="true" position="0"> <maml:name>TaskId</maml:name> <maml:Description> <maml:para> The ID of the repair task. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>State</maml:name> <maml:Description> <maml:para> The workflow state of the repair task. Valid initial states are Created, Claimed, and Preparing. Possible values include: 'Invalid', 'Created', 'Claimed', 'Preparing', 'Approved', 'Executing', 'Restoring', 'Completed' </maml:para> </maml:Description> <command:parameterValue required="true">State?</command:parameterValue> <dev:type> <maml:name>State?</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Action</maml:name> <maml:Description> <maml:para> The requested repair action. Must be specified when the repair task is created, and is immutable once set. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Version</maml:name> <maml:Description> <maml:para> The version of the repair task. When creating a new repair task, the version must be set to zero. When updating a repair task, the version is used for optimistic concurrency checks. If the version is set to zero, the update will not check for write conflicts. If the version is set to a non-zero value, then the update will only succeed if the actual current version of the repair task matches this value. </maml:para> </maml:Description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Description</maml:name> <maml:Description> <maml:para> A description of the purpose of the repair task, or other informational details. May be set when the repair task is created, and is immutable once set. </maml:para> </maml:Description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>Flags</maml:name> <maml:Description> <maml:para> A bitwise-OR of the following values, which gives additional details about the status of the repair task. - 1 - Cancellation of the repair has been requested - 2 - Abort of the repair has been requested - 4 - Approval of the repair was forced via client request </maml:para> </maml:Description> <command:parameterValue required="false">int?</command:parameterValue> <dev:type> <maml:name>int?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>NodeNames</maml:name> <maml:Description> <maml:para> The list of nodes targeted by a repair action. </maml:para> </maml:Description> <command:parameterValue required="false">IEnumerable<string></command:parameterValue> <dev:type> <maml:name>IEnumerable<string></maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Executor</maml:name> <maml:Description> <maml:para> The name of the repair executor. Must be specified in Claimed and later states, and is immutable once set. </maml:para> </maml:Description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>ExecutorData</maml:name> <maml:Description> <maml:para> A data string that the repair executor can use to store its internal state. </maml:para> </maml:Description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>NodeImpactList</maml:name> <maml:Description> <maml:para> The list of nodes impacted by a repair action and their respective expected impact. </maml:para> </maml:Description> <command:parameterValue required="false">IEnumerable<NodeImpact></command:parameterValue> <dev:type> <maml:name>IEnumerable<NodeImpact></maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>ResultStatus</maml:name> <maml:Description> <maml:para> A value describing the overall result of the repair task execution. Must be specified in the Restoring and later states, and is immutable once set. Possible values include: 'Invalid', 'Succeeded', 'Cancelled', 'Interrupted', 'Failed', 'Pending' </maml:para> </maml:Description> <command:parameterValue required="false">ResultStatus?</command:parameterValue> <dev:type> <maml:name>ResultStatus?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>ResultCode</maml:name> <maml:Description> <maml:para> A numeric value providing additional details about the result of the repair task execution. May be specified in the Restoring and later states, and is immutable once set. </maml:para> </maml:Description> <command:parameterValue required="false">int?</command:parameterValue> <dev:type> <maml:name>int?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>ResultDetails</maml:name> <maml:Description> <maml:para> A string providing additional details about the result of the repair task execution. May be specified in the Restoring and later states, and is immutable once set. </maml:para> </maml:Description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>CreatedUtcTimestamp</maml:name> <maml:Description> <maml:para> The time when the repair task entered the Created state. </maml:para> </maml:Description> <command:parameterValue required="false">DateTime?</command:parameterValue> <dev:type> <maml:name>DateTime?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>ClaimedUtcTimestamp</maml:name> <maml:Description> <maml:para> The time when the repair task entered the Claimed state. </maml:para> </maml:Description> <command:parameterValue required="false">DateTime?</command:parameterValue> <dev:type> <maml:name>DateTime?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>PreparingUtcTimestamp</maml:name> <maml:Description> <maml:para> The time when the repair task entered the Preparing state. </maml:para> </maml:Description> <command:parameterValue required="false">DateTime?</command:parameterValue> <dev:type> <maml:name>DateTime?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>ApprovedUtcTimestamp</maml:name> <maml:Description> <maml:para> The time when the repair task entered the Approved state </maml:para> </maml:Description> <command:parameterValue required="false">DateTime?</command:parameterValue> <dev:type> <maml:name>DateTime?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>ExecutingUtcTimestamp</maml:name> <maml:Description> <maml:para> The time when the repair task entered the Executing state </maml:para> </maml:Description> <command:parameterValue required="false">DateTime?</command:parameterValue> <dev:type> <maml:name>DateTime?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>RestoringUtcTimestamp</maml:name> <maml:Description> <maml:para> The time when the repair task entered the Restoring state </maml:para> </maml:Description> <command:parameterValue required="false">DateTime?</command:parameterValue> <dev:type> <maml:name>DateTime?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>CompletedUtcTimestamp</maml:name> <maml:Description> <maml:para> The time when the repair task entered the Completed state </maml:para> </maml:Description> <command:parameterValue required="false">DateTime?</command:parameterValue> <dev:type> <maml:name>DateTime?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>PreparingHealthCheckStartUtcTimestamp</maml:name> <maml:Description> <maml:para> The time when the repair task started the health check in the Preparing state. </maml:para> </maml:Description> <command:parameterValue required="false">DateTime?</command:parameterValue> <dev:type> <maml:name>DateTime?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>PreparingHealthCheckEndUtcTimestamp</maml:name> <maml:Description> <maml:para> The time when the repair task completed the health check in the Preparing state. </maml:para> </maml:Description> <command:parameterValue required="false">DateTime?</command:parameterValue> <dev:type> <maml:name>DateTime?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>RestoringHealthCheckStartUtcTimestamp</maml:name> <maml:Description> <maml:para> The time when the repair task started the health check in the Restoring state. </maml:para> </maml:Description> <command:parameterValue required="false">DateTime?</command:parameterValue> <dev:type> <maml:name>DateTime?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="23"> <maml:name>RestoringHealthCheckEndUtcTimestamp</maml:name> <maml:Description> <maml:para> The time when the repair task completed the health check in the Restoring state. </maml:para> </maml:Description> <command:parameterValue required="false">DateTime?</command:parameterValue> <dev:type> <maml:name>DateTime?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="24"> <maml:name>PreparingHealthCheckState</maml:name> <maml:Description> <maml:para> The workflow state of the health check when the repair task is in the Preparing state. Possible values include: 'NotStarted', 'InProgress', 'Succeeded', 'Skipped', 'TimedOut' Specifies the workflow state of a repair task's health check. This type supports the Service Fabric platform; it is not meant to be used directly from your code. </maml:para> </maml:Description> <command:parameterValue required="false">RepairTaskHealthCheckState?</command:parameterValue> <dev:type> <maml:name>RepairTaskHealthCheckState?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="25"> <maml:name>RestoringHealthCheckState</maml:name> <maml:Description> <maml:para> The workflow state of the health check when the repair task is in the Restoring state. Possible values include: 'NotStarted', 'InProgress', 'Succeeded', 'Skipped', 'TimedOut' Specifies the workflow state of a repair task's health check. This type supports the Service Fabric platform; it is not meant to be used directly from your code. </maml:para> </maml:Description> <command:parameterValue required="false">RepairTaskHealthCheckState?</command:parameterValue> <dev:type> <maml:name>RepairTaskHealthCheckState?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="26"> <maml:name>PerformPreparingHealthCheck</maml:name> <maml:Description> <maml:para> A value to determine if health checks will be performed when the repair task enters the Preparing state. </maml:para> </maml:Description> <command:parameterValue required="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="27"> <maml:name>PerformRestoringHealthCheck</maml:name> <maml:Description> <maml:para> A value to determine if health checks will be performed when the repair task enters the Restoring state. </maml:para> </maml:Description> <command:parameterValue required="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Stop-SFRepairTask</command:name> <command:verb>Stop</command:verb> <command:noun>RepairTask</command:noun> <maml:description> <maml:para>Requests the cancellation of the given repair task.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>This API supports the Service Fabric platform; it is not meant to be used directly from your code. </maml:para> </maml:description> <command:parameters> <command:parameter required="true" position="0"> <maml:name>TaskId</maml:name> <maml:Description> <maml:para> The ID of the repair task. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Version</maml:name> <maml:Description> <maml:para> The current version number of the repair task. If non-zero, then the request will only succeed if this value matches the actual current version of the repair task. If zero, then no version check is performed. </maml:para> </maml:Description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>RequestAbort</maml:name> <maml:Description> <maml:para> _True_ if the repair should be stopped as soon as possible even if it has already started executing. _False_ if the repair should be cancelled only if execution has not yet started. </maml:para> </maml:Description> <command:parameterValue required="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-SFRepairTask</command:name> <command:verb>Remove</command:verb> <command:noun>RepairTask</command:noun> <maml:description> <maml:para>Deletes a completed repair task.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>This API supports the Service Fabric platform; it is not meant to be used directly from your code. </maml:para> </maml:description> <command:parameters> <command:parameter required="true" position="0"> <maml:name>TaskId</maml:name> <maml:Description> <maml:para> The ID of the completed repair task to be deleted. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Version</maml:name> <maml:Description> <maml:para> The current version number of the repair task. If non-zero, then the request will only succeed if this value matches the actual current version of the repair task. If zero, then no version check is performed. </maml:para> </maml:Description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-SFRepairTaskList</command:name> <command:verb>Get</command:verb> <command:noun>RepairTaskList</command:noun> <maml:description> <maml:para>Gets a list of repair tasks matching the given filters.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>This API supports the Service Fabric platform; it is not meant to be used directly from your code. </maml:para> </maml:description> <command:parameters> <command:parameter required="false" position="0"> <maml:name>TaskIdFilter</maml:name> <maml:Description> <maml:para> The repair task ID prefix to be matched. </maml:para> </maml:Description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>StateFilter</maml:name> <maml:Description> <maml:para> A bitwise-OR of the following values, specifying which task states should be included in the result list. - 1 - Created - 2 - Claimed - 4 - Preparing - 8 - Approved - 16 - Executing - 32 - Restoring - 64 - Completed </maml:para> </maml:Description> <command:parameterValue required="false">int?</command:parameterValue> <dev:type> <maml:name>int?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ExecutorFilter</maml:name> <maml:Description> <maml:para> The name of the repair executor whose claimed tasks should be included in the list. </maml:para> </maml:Description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-SFApproveRepairTask</command:name> <command:verb>New</command:verb> <command:noun>ApproveRepairTask</command:noun> <maml:description> <maml:para>Forces the approval of the given repair task.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>This API supports the Service Fabric platform; it is not meant to be used directly from your code. </maml:para> </maml:description> <command:parameters> <command:parameter required="true" position="0"> <maml:name>TaskId</maml:name> <maml:Description> <maml:para> The ID of the repair task. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Version</maml:name> <maml:Description> <maml:para> The current version number of the repair task. If non-zero, then the request will only succeed if this value matches the actual current version of the repair task. If zero, then no version check is performed. </maml:para> </maml:Description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Update-SFRepairTaskHealthPolicy</command:name> <command:verb>Update</command:verb> <command:noun>RepairTaskHealthPolicy</command:noun> <maml:description> <maml:para>Updates the health policy of the given repair task.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>This API supports the Service Fabric platform; it is not meant to be used directly from your code. </maml:para> </maml:description> <command:parameters> <command:parameter required="true" position="0"> <maml:name>TaskId</maml:name> <maml:Description> <maml:para> The ID of the repair task to be updated. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Version</maml:name> <maml:Description> <maml:para> The current version number of the repair task. If non-zero, then the request will only succeed if this value matches the actual current value of the repair task. If zero, then no version check is performed. </maml:para> </maml:Description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>PerformPreparingHealthCheck</maml:name> <maml:Description> <maml:para> A boolean indicating if health check is to be performed in the Preparing stage of the repair task. If not specified the existing value should not be altered. Otherwise, specify the desired new value. </maml:para> </maml:Description> <command:parameterValue required="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>PerformRestoringHealthCheck</maml:name> <maml:Description> <maml:para> A boolean indicating if health check is to be performed in the Restoring stage of the repair task. If not specified the existing value should not be altered. Otherwise, specify the desired new value. </maml:para> </maml:Description> <command:parameterValue required="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Update-SFRepairExecutionState</command:name> <command:verb>Update</command:verb> <command:noun>RepairExecutionState</command:noun> <maml:description> <maml:para>Updates the execution state of a repair task.</maml:para> </maml:description> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Update-SFRepairExecutionState</maml:name> <command:parameter required="false"> <maml:name>NodeNames</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>NodeImpactList</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <maml:description> <maml:para>This API supports the Service Fabric platform; it is not meant to be used directly from your code. </maml:para> </maml:description> <command:parameters> <command:parameter required="true" position="0"> <maml:name>TaskId</maml:name> <maml:Description> <maml:para> The ID of the repair task. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>State</maml:name> <maml:Description> <maml:para> The workflow state of the repair task. Valid initial states are Created, Claimed, and Preparing. Possible values include: 'Invalid', 'Created', 'Claimed', 'Preparing', 'Approved', 'Executing', 'Restoring', 'Completed' </maml:para> </maml:Description> <command:parameterValue required="true">State?</command:parameterValue> <dev:type> <maml:name>State?</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Action</maml:name> <maml:Description> <maml:para> The requested repair action. Must be specified when the repair task is created, and is immutable once set. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>Version</maml:name> <maml:Description> <maml:para> The version of the repair task. When creating a new repair task, the version must be set to zero. When updating a repair task, the version is used for optimistic concurrency checks. If the version is set to zero, the update will not check for write conflicts. If the version is set to a non-zero value, then the update will only succeed if the actual current version of the repair task matches this value. </maml:para> </maml:Description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Description</maml:name> <maml:Description> <maml:para> A description of the purpose of the repair task, or other informational details. May be set when the repair task is created, and is immutable once set. </maml:para> </maml:Description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>Flags</maml:name> <maml:Description> <maml:para> A bitwise-OR of the following values, which gives additional details about the status of the repair task. - 1 - Cancellation of the repair has been requested - 2 - Abort of the repair has been requested - 4 - Approval of the repair was forced via client request </maml:para> </maml:Description> <command:parameterValue required="false">int?</command:parameterValue> <dev:type> <maml:name>int?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>NodeNames</maml:name> <maml:Description> <maml:para> The list of nodes targeted by a repair action. </maml:para> </maml:Description> <command:parameterValue required="false">IEnumerable<string></command:parameterValue> <dev:type> <maml:name>IEnumerable<string></maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Executor</maml:name> <maml:Description> <maml:para> The name of the repair executor. Must be specified in Claimed and later states, and is immutable once set. </maml:para> </maml:Description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>ExecutorData</maml:name> <maml:Description> <maml:para> A data string that the repair executor can use to store its internal state. </maml:para> </maml:Description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>NodeImpactList</maml:name> <maml:Description> <maml:para> The list of nodes impacted by a repair action and their respective expected impact. </maml:para> </maml:Description> <command:parameterValue required="false">IEnumerable<NodeImpact></command:parameterValue> <dev:type> <maml:name>IEnumerable<NodeImpact></maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>ResultStatus</maml:name> <maml:Description> <maml:para> A value describing the overall result of the repair task execution. Must be specified in the Restoring and later states, and is immutable once set. Possible values include: 'Invalid', 'Succeeded', 'Cancelled', 'Interrupted', 'Failed', 'Pending' </maml:para> </maml:Description> <command:parameterValue required="false">ResultStatus?</command:parameterValue> <dev:type> <maml:name>ResultStatus?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>ResultCode</maml:name> <maml:Description> <maml:para> A numeric value providing additional details about the result of the repair task execution. May be specified in the Restoring and later states, and is immutable once set. </maml:para> </maml:Description> <command:parameterValue required="false">int?</command:parameterValue> <dev:type> <maml:name>int?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>ResultDetails</maml:name> <maml:Description> <maml:para> A string providing additional details about the result of the repair task execution. May be specified in the Restoring and later states, and is immutable once set. </maml:para> </maml:Description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>CreatedUtcTimestamp</maml:name> <maml:Description> <maml:para> The time when the repair task entered the Created state. </maml:para> </maml:Description> <command:parameterValue required="false">DateTime?</command:parameterValue> <dev:type> <maml:name>DateTime?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>ClaimedUtcTimestamp</maml:name> <maml:Description> <maml:para> The time when the repair task entered the Claimed state. </maml:para> </maml:Description> <command:parameterValue required="false">DateTime?</command:parameterValue> <dev:type> <maml:name>DateTime?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>PreparingUtcTimestamp</maml:name> <maml:Description> <maml:para> The time when the repair task entered the Preparing state. </maml:para> </maml:Description> <command:parameterValue required="false">DateTime?</command:parameterValue> <dev:type> <maml:name>DateTime?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>ApprovedUtcTimestamp</maml:name> <maml:Description> <maml:para> The time when the repair task entered the Approved state </maml:para> </maml:Description> <command:parameterValue required="false">DateTime?</command:parameterValue> <dev:type> <maml:name>DateTime?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>ExecutingUtcTimestamp</maml:name> <maml:Description> <maml:para> The time when the repair task entered the Executing state </maml:para> </maml:Description> <command:parameterValue required="false">DateTime?</command:parameterValue> <dev:type> <maml:name>DateTime?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>RestoringUtcTimestamp</maml:name> <maml:Description> <maml:para> The time when the repair task entered the Restoring state </maml:para> </maml:Description> <command:parameterValue required="false">DateTime?</command:parameterValue> <dev:type> <maml:name>DateTime?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>CompletedUtcTimestamp</maml:name> <maml:Description> <maml:para> The time when the repair task entered the Completed state </maml:para> </maml:Description> <command:parameterValue required="false">DateTime?</command:parameterValue> <dev:type> <maml:name>DateTime?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>PreparingHealthCheckStartUtcTimestamp</maml:name> <maml:Description> <maml:para> The time when the repair task started the health check in the Preparing state. </maml:para> </maml:Description> <command:parameterValue required="false">DateTime?</command:parameterValue> <dev:type> <maml:name>DateTime?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>PreparingHealthCheckEndUtcTimestamp</maml:name> <maml:Description> <maml:para> The time when the repair task completed the health check in the Preparing state. </maml:para> </maml:Description> <command:parameterValue required="false">DateTime?</command:parameterValue> <dev:type> <maml:name>DateTime?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>RestoringHealthCheckStartUtcTimestamp</maml:name> <maml:Description> <maml:para> The time when the repair task started the health check in the Restoring state. </maml:para> </maml:Description> <command:parameterValue required="false">DateTime?</command:parameterValue> <dev:type> <maml:name>DateTime?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="23"> <maml:name>RestoringHealthCheckEndUtcTimestamp</maml:name> <maml:Description> <maml:para> The time when the repair task completed the health check in the Restoring state. </maml:para> </maml:Description> <command:parameterValue required="false">DateTime?</command:parameterValue> <dev:type> <maml:name>DateTime?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="24"> <maml:name>PreparingHealthCheckState</maml:name> <maml:Description> <maml:para> The workflow state of the health check when the repair task is in the Preparing state. Possible values include: 'NotStarted', 'InProgress', 'Succeeded', 'Skipped', 'TimedOut' Specifies the workflow state of a repair task's health check. This type supports the Service Fabric platform; it is not meant to be used directly from your code. </maml:para> </maml:Description> <command:parameterValue required="false">RepairTaskHealthCheckState?</command:parameterValue> <dev:type> <maml:name>RepairTaskHealthCheckState?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="25"> <maml:name>RestoringHealthCheckState</maml:name> <maml:Description> <maml:para> The workflow state of the health check when the repair task is in the Restoring state. Possible values include: 'NotStarted', 'InProgress', 'Succeeded', 'Skipped', 'TimedOut' Specifies the workflow state of a repair task's health check. This type supports the Service Fabric platform; it is not meant to be used directly from your code. </maml:para> </maml:Description> <command:parameterValue required="false">RepairTaskHealthCheckState?</command:parameterValue> <dev:type> <maml:name>RepairTaskHealthCheckState?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="26"> <maml:name>PerformPreparingHealthCheck</maml:name> <maml:Description> <maml:para> A value to determine if health checks will be performed when the repair task enters the Preparing state. </maml:para> </maml:Description> <command:parameterValue required="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="27"> <maml:name>PerformRestoringHealthCheck</maml:name> <maml:Description> <maml:para> A value to determine if health checks will be performed when the repair task enters the Restoring state. </maml:para> </maml:Description> <command:parameterValue required="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-SFReplica</command:name> <command:verb>Get</command:verb> <command:noun>Replica</command:noun> <maml:description> <maml:para>Gets the information about replicas of a Service Fabric service partition.</maml:para> </maml:description> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-SFReplica</maml:name> <command:parameter required="true"> <maml:name>PartitionId</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>ServerTimeout</maml:name> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-SFReplica</maml:name> <command:parameter required="true"> <maml:name>PartitionId</maml:name> </command:parameter> <command:parameter required="true"> <maml:name>ReplicaId</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>ServerTimeout</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <maml:description> <maml:para>The GetReplicas endpoint returns information about the replicas of the specified partition. The response includes the ID, role, status, health, node name, uptime, and other details about the replica.</maml:para> </maml:description> <command:parameters> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="0"> <maml:name>PartitionId</maml:name> <maml:Description> <maml:para> The identity of the partition. </maml:para> </maml:Description> <command:parameterValue required="true">PartitionId</command:parameterValue> <dev:type> <maml:name>PartitionId</maml:name> </dev:type> </command:parameter> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="1"> <maml:name>ReplicaId</maml:name> <maml:Description> <maml:para> The identifier of the replica. </maml:para> </maml:Description> <command:parameterValue required="true">ReplicaId</command:parameterValue> <dev:type> <maml:name>ReplicaId</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-SFReplicaHealth</command:name> <command:verb>Get</command:verb> <command:noun>ReplicaHealth</command:noun> <maml:description> <maml:para>Gets the health of a Service Fabric stateful service replica or stateless service instance.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Gets the health of a Service Fabric replica. Use EventsHealthStateFilter to filter the collection of health events reported on the replica based on the health state. </maml:para> </maml:description> <command:parameters> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="0"> <maml:name>PartitionId</maml:name> <maml:Description> <maml:para> The identity of the partition. </maml:para> </maml:Description> <command:parameterValue required="true">PartitionId</command:parameterValue> <dev:type> <maml:name>PartitionId</maml:name> </dev:type> </command:parameter> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="1"> <maml:name>ReplicaId</maml:name> <maml:Description> <maml:para> The identifier of the replica. </maml:para> </maml:Description> <command:parameterValue required="true">ReplicaId</command:parameterValue> <dev:type> <maml:name>ReplicaId</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>EventsHealthStateFilter</maml:name> <maml:Description> <maml:para> 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. - Default - Default value. Matches any HealthState. The value is zero. - 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. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - Error - Filter that matches input with HealthState value Error. The value is 8. - All - Filter that matches input with any HealthState value. The value is 65535. </maml:para> </maml:Description> <command:parameterValue required="false">int?</command:parameterValue> <dev:type> <maml:name>int?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-SFReplicaHealthUsingPolicy</command:name> <command:verb>Get</command:verb> <command:noun>ReplicaHealthUsingPolicy</command:noun> <maml:description> <maml:para>Gets the health of a Service Fabric stateful service replica or stateless service instance using the specified policy.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Gets the health of a Service Fabric stateful service replica or stateless service instance. Use EventsHealthStateFilter to filter the collection of health events reported on the cluster based on the health state. Use ApplicationHealthPolicy to optionally override the health policies used to evaluate the health. This API only uses 'ConsiderWarningAsError' field of the ApplicationHealthPolicy. The rest of the fields are ignored while evaluating the health of the replica. </maml:para> </maml:description> <command:parameters> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="0"> <maml:name>PartitionId</maml:name> <maml:Description> <maml:para> The identity of the partition. </maml:para> </maml:Description> <command:parameterValue required="true">PartitionId</command:parameterValue> <dev:type> <maml:name>PartitionId</maml:name> </dev:type> </command:parameter> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="1"> <maml:name>ReplicaId</maml:name> <maml:Description> <maml:para> The identifier of the replica. </maml:para> </maml:Description> <command:parameterValue required="true">ReplicaId</command:parameterValue> <dev:type> <maml:name>ReplicaId</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>EventsHealthStateFilter</maml:name> <maml:Description> <maml:para> 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. - Default - Default value. Matches any HealthState. The value is zero. - 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. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - Error - Filter that matches input with HealthState value Error. The value is 8. - All - Filter that matches input with any HealthState value. The value is 65535. </maml:para> </maml:Description> <command:parameterValue required="false">int?</command:parameterValue> <dev:type> <maml:name>int?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>ConsiderWarningAsError</maml:name> <maml:Description> <maml:para> Indicates whether warnings are treated with the same severity as errors. </maml:para> </maml:Description> <command:parameterValue required="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>MaxPercentUnhealthyDeployedApplications</maml:name> <maml:Description> <maml:para> The maximum allowed percentage of unhealthy deployed applications. Allowed values are Byte values from zero to 100. The percentage represents the maximum tolerated percentage of deployed applications that can be unhealthy before the application is considered in error. This is calculated by dividing the number of unhealthy deployed applications over the number of nodes where the application is currently deployed on in the cluster. The computation rounds up to tolerate one failure on small numbers of nodes. Default percentage is zero. </maml:para> </maml:Description> <command:parameterValue required="false">int?</command:parameterValue> <dev:type> <maml:name>int?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>MaxPercentUnhealthyPartitionsPerService</maml:name> <maml:Description> <maml:para> The maximum allowed percentage of unhealthy partitions per service. Allowed values are Byte values from zero to 100 The percentage represents the maximum tolerated percentage of partitions that can be unhealthy before the service is considered in error. If the percentage is respected but there is at least one unhealthy partition, the health is evaluated as Warning. The percentage is calculated by dividing the number of unhealthy partitions over the total number of partitions in the service. The computation rounds up to tolerate one failure on small numbers of partitions. Default percentage is zero. </maml:para> </maml:Description> <command:parameterValue required="false">int?</command:parameterValue> <dev:type> <maml:name>int?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>MaxPercentUnhealthyReplicasPerPartition</maml:name> <maml:Description> <maml:para> The maximum allowed percentage of unhealthy replicas per partition. Allowed values are Byte values from zero to 100. The percentage represents the maximum tolerated percentage of replicas that can be unhealthy before the partition is considered in error. If the percentage is respected but there is at least one unhealthy replica, the health is evaluated as Warning. The percentage is calculated by dividing the number of unhealthy replicas over the total number of replicas in the partition. The computation rounds up to tolerate one failure on small numbers of replicas. Default percentage is zero. </maml:para> </maml:Description> <command:parameterValue required="false">int?</command:parameterValue> <dev:type> <maml:name>int?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>MaxPercentUnhealthyServices</maml:name> <maml:Description> <maml:para> The maximum allowed percentage of unhealthy services. Allowed values are Byte values from zero to 100. The percentage represents the maximum tolerated percentage of services that can be unhealthy before the application is considered in error. If the percentage is respected but there is at least one unhealthy service, the health is evaluated as Warning. This is calculated by dividing the number of unhealthy services of the specific service type over the total number of services of the specific service type. The computation rounds up to tolerate one failure on small numbers of services. Default percentage is zero. </maml:para> </maml:Description> <command:parameterValue required="false">int?</command:parameterValue> <dev:type> <maml:name>int?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>ServiceTypeHealthPolicyMap</maml:name> <maml:Description> <maml:para> The map with service type health policy per service type name. The map is empty by default. </maml:para> </maml:Description> <command:parameterValue required="false">IEnumerable<ServiceTypeHealthPolicyMapItem></command:parameterValue> <dev:type> <maml:name>IEnumerable<ServiceTypeHealthPolicyMapItem></maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-SFReplicaHealth</command:name> <command:verb>New</command:verb> <command:noun>ReplicaHealth</command:noun> <maml:description> <maml:para>Sends a health report on the Service Fabric replica.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Reports health state of the specified Service Fabric replica. The report must contain the information about the source of the health report and property on which it is reported. The report is sent to a Service Fabric gateway Replica, which forwards to the health store. The report may be accepted by the gateway, but rejected by the health store after extra validation. For example, the health store may reject the report because of an invalid parameter, like a stale sequence number. To see whether the report was applied in the health store, run GetReplicaHealth and check that the report appears in the HealthEvents section. </maml:para> </maml:description> <command:parameters> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="0"> <maml:name>PartitionId</maml:name> <maml:Description> <maml:para> The identity of the partition. </maml:para> </maml:Description> <command:parameterValue required="true">PartitionId</command:parameterValue> <dev:type> <maml:name>PartitionId</maml:name> </dev:type> </command:parameter> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="1"> <maml:name>ReplicaId</maml:name> <maml:Description> <maml:para> The identifier of the replica. </maml:para> </maml:Description> <command:parameterValue required="true">ReplicaId</command:parameterValue> <dev:type> <maml:name>ReplicaId</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>ServiceKind</maml:name> <maml:Description> <maml:para> The kind of service replica (Stateless or Stateful) for which the health is being reported. Following are the possible values. Possible values include: 'Stateless', 'Stateful' </maml:para> </maml:Description> <command:parameterValue required="true">ReplicaHealthReportServiceKind?</command:parameterValue> <dev:type> <maml:name>ReplicaHealthReportServiceKind?</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="3"> <maml:name>SourceId</maml:name> <maml:Description> <maml:para> The source name that identifies the client/watchdog/system component that generated the health information. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="4"> <maml:name>Property</maml:name> <maml:Description> <maml:para> The property of the health information. An entity can have health reports for different properties. The property is a string and not a fixed enumeration to allow the reporter flexibility to categorize the state condition that triggers the report. For example, a reporter with SourceId "LocalWatchdog" can monitor the state of the available disk on a node, so it can report "AvailableDisk" property on that node. The same reporter can monitor the node connectivity, so it can report a property "Connectivity" on the same node. In the health store, these reports are treated as separate health events for the specified node. Together with the SourceId, the property uniquely identifies the health information. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="5"> <maml:name>HealthState</maml:name> <maml:Description> <maml:para> The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown' </maml:para> </maml:Description> <command:parameterValue required="true">HealthState?</command:parameterValue> <dev:type> <maml:name>HealthState?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>TimeToLiveInMilliSeconds</maml:name> <maml:Description> <maml:para> The duration for which this health report is valid. This field uses ISO8601 format for specifying the duration. 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. </maml:para> </maml:Description> <command:parameterValue required="false">TimeSpan?</command:parameterValue> <dev:type> <maml:name>TimeSpan?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Description</maml:name> <maml:Description> <maml:para> The description of the health information. It represents free text used to add human readable information about the report. The maximum string length for the description is 4096 characters. If the provided string is longer, it will be automatically truncated. When truncated, the last characters of the description contain a marker "[Truncated]", and total string size is 4096 characters. The presence of the marker indicates to users that truncation occurred. Note that when truncated, the description has less than 4096 characters from the original string. </maml:para> </maml:Description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>SequenceNumber</maml:name> <maml:Description> <maml:para> The sequence number for this health report as a numeric string. 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. </maml:para> </maml:Description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>RemoveWhenExpired</maml:name> <maml:Description> <maml:para> Value that indicates whether the report is removed from health store when it expires. 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, if 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. </maml:para> </maml:Description> <command:parameterValue required="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Immediate</maml:name> <maml:Description> <maml:para> A flag that indicates whether the report should be sent immediately. A health report is sent to a Service Fabric gateway Application, which forwards to the health store. If Immediate is set to true, the report is sent immediately from HTTP Gateway to the health store, regardless of the fabric client settings that the HTTP Gateway Application is using. This is useful for critical reports that should be sent as soon as possible. Depending on timing and other conditions, sending the report may still fail, for example if the HTTP Gateway is closed or the message doesn't reach the Gateway. If Immediate is set to false, the report is sent based on the health client settings from the HTTP Gateway. Therefore, it will be batched according to the HealthReportSendInterval configuration. This is the recommended setting because it allows the health client to optimize health reporting messages to health store as well as health report processing. By default, reports are not sent immediately. </maml:para> </maml:Description> <command:parameterValue required="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-SFDeployedServiceReplicaInfoList</command:name> <command:verb>Get</command:verb> <command:noun>DeployedServiceReplicaInfoList</command:noun> <maml:description> <maml:para>Gets the list of replicas deployed on a Service Fabric node.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Gets the list containing the information about replicas deployed on a Service Fabric node. The information include partition ID, replica ID, status of the replica, name of the service, name of the service type, and other information. Use PartitionId or ServiceManifestName query parameters to return information about the deployed replicas matching the specified values for those parameters.</maml:para> </maml:description> <command:parameters> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="0"> <maml:name>NodeName</maml:name> <maml:Description> <maml:para> The name of the node. </maml:para> </maml:Description> <command:parameterValue required="true">NodeName</command:parameterValue> <dev:type> <maml:name>NodeName</maml:name> </dev:type> </command:parameter> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="1"> <maml:name>ApplicationId</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>PartitionId</maml:name> <maml:Description> <maml:para> The identity of the partition. </maml:para> </maml:Description> <command:parameterValue required="false">PartitionId</command:parameterValue> <dev:type> <maml:name>PartitionId</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>ServiceManifestName</maml:name> <maml:Description> <maml:para> The name of a service manifest registered as part of an application type in a Service Fabric cluster. </maml:para> </maml:Description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-SFDeployedServiceReplicaDetail</command:name> <command:verb>Get</command:verb> <command:noun>DeployedServiceReplicaDetail</command:noun> <maml:description> <maml:para>Gets the details of replica deployed on a Service Fabric node.</maml:para> </maml:description> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-SFDeployedServiceReplicaDetail</maml:name> <command:parameter required="true"> <maml:name>NodeName</maml:name> </command:parameter> <command:parameter required="true"> <maml:name>PartitionId</maml:name> </command:parameter> <command:parameter required="true"> <maml:name>ReplicaId</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>ServerTimeout</maml:name> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-SFDeployedServiceReplicaDetail</maml:name> <command:parameter required="true"> <maml:name>NodeName</maml:name> </command:parameter> <command:parameter required="true"> <maml:name>PartitionId</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>ServerTimeout</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <maml:description> <maml:para>Gets the details of the replica deployed on a Service Fabric node. The information includes service kind, service name, current service operation, current service operation start date time, partition ID, replica/instance ID, reported load, and other information.</maml:para> </maml:description> <command:parameters> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="0"> <maml:name>NodeName</maml:name> <maml:Description> <maml:para> The name of the node. </maml:para> </maml:Description> <command:parameterValue required="true">NodeName</command:parameterValue> <dev:type> <maml:name>NodeName</maml:name> </dev:type> </command:parameter> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="1"> <maml:name>PartitionId</maml:name> <maml:Description> <maml:para> The identity of the partition. </maml:para> </maml:Description> <command:parameterValue required="true">PartitionId</command:parameterValue> <dev:type> <maml:name>PartitionId</maml:name> </dev:type> </command:parameter> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="2"> <maml:name>ReplicaId</maml:name> <maml:Description> <maml:para> The identifier of the replica. </maml:para> </maml:Description> <command:parameterValue required="true">ReplicaId</command:parameterValue> <dev:type> <maml:name>ReplicaId</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Restart-SFReplica</command:name> <command:verb>Restart</command:verb> <command:noun>Replica</command:noun> <maml:description> <maml:para>Restarts a service replica of a persisted service running on a node.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Restarts a service replica of a persisted service running on a node. Warning - There are no safety checks performed when this API is used. Incorrect use of this API can lead to availability loss for stateful services.</maml:para> </maml:description> <command:parameters> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="0"> <maml:name>NodeName</maml:name> <maml:Description> <maml:para> The name of the node. </maml:para> </maml:Description> <command:parameterValue required="true">NodeName</command:parameterValue> <dev:type> <maml:name>NodeName</maml:name> </dev:type> </command:parameter> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="1"> <maml:name>PartitionId</maml:name> <maml:Description> <maml:para> The identity of the partition. </maml:para> </maml:Description> <command:parameterValue required="true">PartitionId</command:parameterValue> <dev:type> <maml:name>PartitionId</maml:name> </dev:type> </command:parameter> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="2"> <maml:name>ReplicaId</maml:name> <maml:Description> <maml:para> The identifier of the replica. </maml:para> </maml:Description> <command:parameterValue required="true">ReplicaId</command:parameterValue> <dev:type> <maml:name>ReplicaId</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-SFReplica</command:name> <command:verb>Remove</command:verb> <command:noun>Replica</command:noun> <maml:description> <maml:para>Removes a service replica running on a node.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>This API simulates a Service Fabric replica failure by removing a replica from a Service Fabric cluster. The removal closes the replica, transitions the replica to the role None, and then removes all of the state information of the replica from the cluster. This API tests the replica state removal path, and simulates the report fault permanent path through client APIs. Warning - There are no safety checks performed when this API is used. Incorrect use of this API can lead to data loss for stateful services. In addition, the forceRemove flag impacts all other replicas hosted in the same process.</maml:para> </maml:description> <command:parameters> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="0"> <maml:name>NodeName</maml:name> <maml:Description> <maml:para> The name of the node. </maml:para> </maml:Description> <command:parameterValue required="true">NodeName</command:parameterValue> <dev:type> <maml:name>NodeName</maml:name> </dev:type> </command:parameter> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="1"> <maml:name>PartitionId</maml:name> <maml:Description> <maml:para> The identity of the partition. </maml:para> </maml:Description> <command:parameterValue required="true">PartitionId</command:parameterValue> <dev:type> <maml:name>PartitionId</maml:name> </dev:type> </command:parameter> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="2"> <maml:name>ReplicaId</maml:name> <maml:Description> <maml:para> The identifier of the replica. </maml:para> </maml:Description> <command:parameterValue required="true">ReplicaId</command:parameterValue> <dev:type> <maml:name>ReplicaId</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>ForceRemove</maml:name> <maml:Description> <maml:para> Remove a Service Fabric application or service forcefully without going through the graceful shutdown sequence. This parameter can be used to forcefully delete an application or service for which delete is timing out due to issues in the service code that prevents graceful close of replicas. </maml:para> </maml:Description> <command:parameterValue required="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-SFDeployedServicePackage</command:name> <command:verb>Get</command:verb> <command:noun>DeployedServicePackage</command:noun> <maml:description> <maml:para>Gets the list of service packages deployed on a Service Fabric node.</maml:para> </maml:description> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-SFDeployedServicePackage</maml:name> <command:parameter required="true"> <maml:name>NodeName</maml:name> </command:parameter> <command:parameter required="true"> <maml:name>ApplicationId</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>ServerTimeout</maml:name> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-SFDeployedServicePackage</maml:name> <command:parameter required="true"> <maml:name>NodeName</maml:name> </command:parameter> <command:parameter required="true"> <maml:name>ApplicationId</maml:name> </command:parameter> <command:parameter required="true"> <maml:name>ServicePackageName</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>ServerTimeout</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <maml:description> <maml:para>Returns the information about the service packages deployed on a Service Fabric node for the given application.</maml:para> </maml:description> <command:parameters> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="0"> <maml:name>NodeName</maml:name> <maml:Description> <maml:para> The name of the node. </maml:para> </maml:Description> <command:parameterValue required="true">NodeName</command:parameterValue> <dev:type> <maml:name>NodeName</maml:name> </dev:type> </command:parameter> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="1"> <maml:name>ApplicationId</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="2"> <maml:name>ServicePackageName</maml:name> <maml:Description> <maml:para> The name of the service package. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-SFDeployedServicePackageHealth</command:name> <command:verb>Get</command:verb> <command:noun>DeployedServicePackageHealth</command:noun> <maml:description> <maml:para>Gets the information about health of a service package for a specific application deployed for a Service Fabric node and application.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Gets the information about health of a service package for a specific application deployed on a Service Fabric node. Use EventsHealthStateFilter to optionally filter for the collection of HealthEvent objects reported on the deployed service package based on health state.</maml:para> </maml:description> <command:parameters> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="0"> <maml:name>NodeName</maml:name> <maml:Description> <maml:para> The name of the node. </maml:para> </maml:Description> <command:parameterValue required="true">NodeName</command:parameterValue> <dev:type> <maml:name>NodeName</maml:name> </dev:type> </command:parameter> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="1"> <maml:name>ApplicationId</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="2"> <maml:name>ServicePackageName</maml:name> <maml:Description> <maml:para> The name of the service package. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>EventsHealthStateFilter</maml:name> <maml:Description> <maml:para> 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. - Default - Default value. Matches any HealthState. The value is zero. - 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. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - Error - Filter that matches input with HealthState value Error. The value is 8. - All - Filter that matches input with any HealthState value. The value is 65535. </maml:para> </maml:Description> <command:parameterValue required="false">int?</command:parameterValue> <dev:type> <maml:name>int?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-SFDeployedServicePackageHealthUsingPolicy</command:name> <command:verb>Get</command:verb> <command:noun>DeployedServicePackageHealthUsingPolicy</command:noun> <maml:description> <maml:para>Gets the information about health of service package for a specific application deployed on a Service Fabric node using the specified policy.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Gets the information about health of a service package for a specific application deployed on a Service Fabric node. using the specified policy. Use EventsHealthStateFilter to optionally filter for the collection of HealthEvent objects reported on the deployed service package based on health state. Use ApplicationHealthPolicy to optionally override the health policies used to evaluate the health. This API only uses 'ConsiderWarningAsError' field of the ApplicationHealthPolicy. The rest of the fields are ignored while evaluating the health of the deployed service package. </maml:para> </maml:description> <command:parameters> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="0"> <maml:name>NodeName</maml:name> <maml:Description> <maml:para> The name of the node. </maml:para> </maml:Description> <command:parameterValue required="true">NodeName</command:parameterValue> <dev:type> <maml:name>NodeName</maml:name> </dev:type> </command:parameter> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="1"> <maml:name>ApplicationId</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="2"> <maml:name>ServicePackageName</maml:name> <maml:Description> <maml:para> The name of the service package. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>EventsHealthStateFilter</maml:name> <maml:Description> <maml:para> 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. - Default - Default value. Matches any HealthState. The value is zero. - 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. - Ok - Filter that matches input with HealthState value Ok. The value is 2. - Warning - Filter that matches input with HealthState value Warning. The value is 4. - Error - Filter that matches input with HealthState value Error. The value is 8. - All - Filter that matches input with any HealthState value. The value is 65535. </maml:para> </maml:Description> <command:parameterValue required="false">int?</command:parameterValue> <dev:type> <maml:name>int?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>ConsiderWarningAsError</maml:name> <maml:Description> <maml:para> Indicates whether warnings are treated with the same severity as errors. </maml:para> </maml:Description> <command:parameterValue required="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>MaxPercentUnhealthyDeployedApplications</maml:name> <maml:Description> <maml:para> The maximum allowed percentage of unhealthy deployed applications. Allowed values are Byte values from zero to 100. The percentage represents the maximum tolerated percentage of deployed applications that can be unhealthy before the application is considered in error. This is calculated by dividing the number of unhealthy deployed applications over the number of nodes where the application is currently deployed on in the cluster. The computation rounds up to tolerate one failure on small numbers of nodes. Default percentage is zero. </maml:para> </maml:Description> <command:parameterValue required="false">int?</command:parameterValue> <dev:type> <maml:name>int?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>MaxPercentUnhealthyPartitionsPerService</maml:name> <maml:Description> <maml:para> The maximum allowed percentage of unhealthy partitions per service. Allowed values are Byte values from zero to 100 The percentage represents the maximum tolerated percentage of partitions that can be unhealthy before the service is considered in error. If the percentage is respected but there is at least one unhealthy partition, the health is evaluated as Warning. The percentage is calculated by dividing the number of unhealthy partitions over the total number of partitions in the service. The computation rounds up to tolerate one failure on small numbers of partitions. Default percentage is zero. </maml:para> </maml:Description> <command:parameterValue required="false">int?</command:parameterValue> <dev:type> <maml:name>int?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>MaxPercentUnhealthyReplicasPerPartition</maml:name> <maml:Description> <maml:para> The maximum allowed percentage of unhealthy replicas per partition. Allowed values are Byte values from zero to 100. The percentage represents the maximum tolerated percentage of replicas that can be unhealthy before the partition is considered in error. If the percentage is respected but there is at least one unhealthy replica, the health is evaluated as Warning. The percentage is calculated by dividing the number of unhealthy replicas over the total number of replicas in the partition. The computation rounds up to tolerate one failure on small numbers of replicas. Default percentage is zero. </maml:para> </maml:Description> <command:parameterValue required="false">int?</command:parameterValue> <dev:type> <maml:name>int?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>MaxPercentUnhealthyServices</maml:name> <maml:Description> <maml:para> The maximum allowed percentage of unhealthy services. Allowed values are Byte values from zero to 100. The percentage represents the maximum tolerated percentage of services that can be unhealthy before the application is considered in error. If the percentage is respected but there is at least one unhealthy service, the health is evaluated as Warning. This is calculated by dividing the number of unhealthy services of the specific service type over the total number of services of the specific service type. The computation rounds up to tolerate one failure on small numbers of services. Default percentage is zero. </maml:para> </maml:Description> <command:parameterValue required="false">int?</command:parameterValue> <dev:type> <maml:name>int?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>ServiceTypeHealthPolicyMap</maml:name> <maml:Description> <maml:para> The map with service type health policy per service type name. The map is empty by default. </maml:para> </maml:Description> <command:parameterValue required="false">IEnumerable<ServiceTypeHealthPolicyMapItem></command:parameterValue> <dev:type> <maml:name>IEnumerable<ServiceTypeHealthPolicyMapItem></maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-SFDeployedServicePackageHealth</command:name> <command:verb>New</command:verb> <command:noun>DeployedServicePackageHealth</command:noun> <maml:description> <maml:para>Sends a health report on the Service Fabric deployed service package.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Reports health state of the service package of the application deployed on a Service Fabric node. The report must contain the information about the source of the health report and property on which it is reported. The report is sent to a Service Fabric gateway Service, which forwards to the health store. The report may be accepted by the gateway, but rejected by the health store after extra validation. For example, the health store may reject the report because of an invalid parameter, like a stale sequence number. To see whether the report was applied in the health store, get deployed service package health and check that the report appears in the HealthEvents section. </maml:para> </maml:description> <command:parameters> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="0"> <maml:name>NodeName</maml:name> <maml:Description> <maml:para> The name of the node. </maml:para> </maml:Description> <command:parameterValue required="true">NodeName</command:parameterValue> <dev:type> <maml:name>NodeName</maml:name> </dev:type> </command:parameter> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="1"> <maml:name>ApplicationId</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="2"> <maml:name>ServicePackageName</maml:name> <maml:Description> <maml:para> The name of the service package. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="3"> <maml:name>SourceId</maml:name> <maml:Description> <maml:para> The source name that identifies the client/watchdog/system component that generated the health information. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="4"> <maml:name>Property</maml:name> <maml:Description> <maml:para> The property of the health information. An entity can have health reports for different properties. The property is a string and not a fixed enumeration to allow the reporter flexibility to categorize the state condition that triggers the report. For example, a reporter with SourceId "LocalWatchdog" can monitor the state of the available disk on a node, so it can report "AvailableDisk" property on that node. The same reporter can monitor the node connectivity, so it can report a property "Connectivity" on the same node. In the health store, these reports are treated as separate health events for the specified node. Together with the SourceId, the property uniquely identifies the health information. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="5"> <maml:name>HealthState</maml:name> <maml:Description> <maml:para> The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown' </maml:para> </maml:Description> <command:parameterValue required="true">HealthState?</command:parameterValue> <dev:type> <maml:name>HealthState?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>TimeToLiveInMilliSeconds</maml:name> <maml:Description> <maml:para> The duration for which this health report is valid. This field uses ISO8601 format for specifying the duration. 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. </maml:para> </maml:Description> <command:parameterValue required="false">TimeSpan?</command:parameterValue> <dev:type> <maml:name>TimeSpan?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>Description</maml:name> <maml:Description> <maml:para> The description of the health information. It represents free text used to add human readable information about the report. The maximum string length for the description is 4096 characters. If the provided string is longer, it will be automatically truncated. When truncated, the last characters of the description contain a marker "[Truncated]", and total string size is 4096 characters. The presence of the marker indicates to users that truncation occurred. Note that when truncated, the description has less than 4096 characters from the original string. </maml:para> </maml:Description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>SequenceNumber</maml:name> <maml:Description> <maml:para> The sequence number for this health report as a numeric string. 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. </maml:para> </maml:Description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>RemoveWhenExpired</maml:name> <maml:Description> <maml:para> Value that indicates whether the report is removed from health store when it expires. 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, if 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. </maml:para> </maml:Description> <command:parameterValue required="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Immediate</maml:name> <maml:Description> <maml:para> A flag that indicates whether the report should be sent immediately. A health report is sent to a Service Fabric gateway Application, which forwards to the health store. If Immediate is set to true, the report is sent immediately from HTTP Gateway to the health store, regardless of the fabric client settings that the HTTP Gateway Application is using. This is useful for critical reports that should be sent as soon as possible. Depending on timing and other conditions, sending the report may still fail, for example if the HTTP Gateway is closed or the message doesn't reach the Gateway. If Immediate is set to false, the report is sent based on the health client settings from the HTTP Gateway. Therefore, it will be batched according to the HealthReportSendInterval configuration. This is the recommended setting because it allows the health client to optimize health reporting messages to health store as well as health report processing. By default, reports are not sent immediately. </maml:para> </maml:Description> <command:parameterValue required="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Copy-SFServicePackageToNode</command:name> <command:verb>Copy</command:verb> <command:noun>ServicePackageToNode</command:noun> <maml:description> <maml:para>Downloads all of the code packages associated with specified service manifest on the specified node.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>This API provides a way to download code packages including the container images on a specific node outside of the normal application deployment and upgrade path. This is useful for the large code packages and container images to be present on the node before the actual application deployment and upgrade, thus significantly reducing the total time required for the deployment or upgrade. </maml:para> </maml:description> <command:parameters> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="0"> <maml:name>NodeName</maml:name> <maml:Description> <maml:para> The name of the node. </maml:para> </maml:Description> <command:parameterValue required="true">NodeName</command:parameterValue> <dev:type> <maml:name>NodeName</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>ServiceManifestName</maml:name> <maml:Description> <maml:para> The name of service manifest whose packages need to be downloaded. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>ApplicationTypeName</maml:name> <maml:Description> <maml:para> The application type name as defined in the application manifest. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="3"> <maml:name>ApplicationTypeVersion</maml:name> <maml:Description> <maml:para> The version of the application type as defined in the application manifest. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="4"> <maml:name>NodeName</maml:name> <maml:Description> <maml:para> The name of a Service Fabric node. </maml:para> </maml:Description> <command:parameterValue required="true">NodeName</command:parameterValue> <dev:type> <maml:name>NodeName</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>PackageSharingPolicy</maml:name> <maml:Description> <maml:para> List of package sharing policy information. </maml:para> </maml:Description> <command:parameterValue required="false">IEnumerable<PackageSharingPolicyInfo></command:parameterValue> <dev:type> <maml:name>IEnumerable<PackageSharingPolicyInfo></maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-SFDeployedCodePackageInfoList</command:name> <command:verb>Get</command:verb> <command:noun>DeployedCodePackageInfoList</command:noun> <maml:description> <maml:para>Gets the list of code packages deployed on a Service Fabric node.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Gets the list of code packages deployed on a Service Fabric node for the given application.</maml:para> </maml:description> <command:parameters> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="0"> <maml:name>NodeName</maml:name> <maml:Description> <maml:para> The name of the node. </maml:para> </maml:Description> <command:parameterValue required="true">NodeName</command:parameterValue> <dev:type> <maml:name>NodeName</maml:name> </dev:type> </command:parameter> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="1"> <maml:name>ApplicationId</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" pipelineInput="True(ByPropertyName)" position="2"> <maml:name>ServiceManifestName</maml:name> <maml:Description> <maml:para> The name of a service manifest registered as part of an application type in a Service Fabric cluster. </maml:para> </maml:Description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>CodePackageName</maml:name> <maml:Description> <maml:para> The name of code package specified in service manifest registered as part of an application type in a Service Fabric cluster. </maml:para> </maml:Description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Restart-SFDeployedCodePackage</command:name> <command:verb>Restart</command:verb> <command:noun>DeployedCodePackage</command:noun> <maml:description> <maml:para>Restarts a code package deployed on a Service Fabric node in a cluster.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Restarts a code package deployed on a Service Fabric node in a cluster. This aborts the code package process, which will restart all the user service replicas hosted in that process.</maml:para> </maml:description> <command:parameters> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="0"> <maml:name>NodeName</maml:name> <maml:Description> <maml:para> The name of the node. </maml:para> </maml:Description> <command:parameterValue required="true">NodeName</command:parameterValue> <dev:type> <maml:name>NodeName</maml:name> </dev:type> </command:parameter> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="1"> <maml:name>ApplicationId</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>ServiceManifestName</maml:name> <maml:Description> <maml:para> The name of service manifest that specified this code package. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="3"> <maml:name>CodePackageName</maml:name> <maml:Description> <maml:para> The name of the code package defined in the service manifest. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="4"> <maml:name>CodePackageInstanceId</maml:name> <maml:Description> <maml:para> The instance ID for currently running entry point. For a code package setup entry point (if specified) runs first and after it finishes main entry point is started. Each time entry point executable is run, its instance ID will change. If 0 is passed in as the code package instance ID, the API will restart the code package with whatever instance ID it is currently running. If an instance ID other than 0 is passed in, the API will restart the code package only if the current Instance ID matches the passed in instance ID. Note, passing in the exact instance ID (not 0) in the API is safer, because if ensures at most one restart of the code package. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>ServicePackageActivationId</maml:name> <maml:Description> <maml:para> The ActivationId of a deployed service package. If ServicePackageActivationMode specified at the time of creating the service is 'SharedProcess' (or if it is not specified, in which case it defaults to 'SharedProcess'), then value of ServicePackageActivationId is always an empty string. </maml:para> </maml:Description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-SFContainerLogsDeployedOnNode</command:name> <command:verb>Get</command:verb> <command:noun>ContainerLogsDeployedOnNode</command:noun> <maml:description> <maml:para>Gets the container logs for container deployed on a Service Fabric node.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Gets the container logs for container deployed on a Service Fabric node for the given code package.</maml:para> </maml:description> <command:parameters> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="0"> <maml:name>NodeName</maml:name> <maml:Description> <maml:para> The name of the node. </maml:para> </maml:Description> <command:parameterValue required="true">NodeName</command:parameterValue> <dev:type> <maml:name>NodeName</maml:name> </dev:type> </command:parameter> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="1"> <maml:name>ApplicationId</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="2"> <maml:name>ServiceManifestName</maml:name> <maml:Description> <maml:para> The name of a service manifest registered as part of an application type in a Service Fabric cluster. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="3"> <maml:name>CodePackageName</maml:name> <maml:Description> <maml:para> The name of code package specified in service manifest registered as part of an application type in a Service Fabric cluster. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Tail</maml:name> <maml:Description> <maml:para> Number of lines to show from the end of the logs. Default is 100. 'all' to show the complete logs. </maml:para> </maml:Description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>Previous</maml:name> <maml:Description> <maml:para> Specifies whether to get container logs from exited/dead containers of the code package instance. </maml:para> </maml:Description> <command:parameterValue required="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-SFContainerApi</command:name> <command:verb>New</command:verb> <command:noun>ContainerApi</command:noun> <maml:description> <maml:para>Invoke container API on a container deployed on a Service Fabric node.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Invoke container API on a container deployed on a Service Fabric node for the given code package.</maml:para> </maml:description> <command:parameters> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="0"> <maml:name>NodeName</maml:name> <maml:Description> <maml:para> The name of the node. </maml:para> </maml:Description> <command:parameterValue required="true">NodeName</command:parameterValue> <dev:type> <maml:name>NodeName</maml:name> </dev:type> </command:parameter> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="1"> <maml:name>ApplicationId</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="2"> <maml:name>ServiceManifestName</maml:name> <maml:Description> <maml:para> The name of a service manifest registered as part of an application type in a Service Fabric cluster. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="3"> <maml:name>CodePackageName</maml:name> <maml:Description> <maml:para> The name of code package specified in service manifest registered as part of an application type in a Service Fabric cluster. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="4"> <maml:name>CodePackageInstanceId</maml:name> <maml:Description> <maml:para> ID that uniquely identifies a code package instance deployed on a service fabric node. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="5"> <maml:name>UriPath</maml:name> <maml:Description> <maml:para> URI path of container REST API </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>HttpVerb</maml:name> <maml:Description> <maml:para> HTTP verb of container REST API, defaults to "GET" </maml:para> </maml:Description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>ContentType</maml:name> <maml:Description> <maml:para> Content type of container REST API request, defaults to "application/json" </maml:para> </maml:Description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>Body</maml:name> <maml:Description> <maml:para> HTTP request body of container REST API </maml:para> </maml:Description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-SFComposeDeployment</command:name> <command:verb>New</command:verb> <command:noun>ComposeDeployment</command:noun> <maml:description> <maml:para>Creates a Service Fabric compose deployment.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Compose is a file format that describes multi-container applications. This API allows deploying container based applications defined in compose format in a Service Fabric cluster. Once the deployment is created, its status can be tracked via the `GetComposeDeploymentStatus` API.</maml:para> </maml:description> <command:parameters> <command:parameter required="true" position="0"> <maml:name>DeploymentName</maml:name> <maml:Description> <maml:para> The name of the deployment. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>ComposeFileContent</maml:name> <maml:Description> <maml:para> The content of the compose file that describes the deployment to create. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>RegistryUserName</maml:name> <maml:Description> <maml:para> The user name to connect to container registry. </maml:para> </maml:Description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>RegistryPassword</maml:name> <maml:Description> <maml:para> The password for supplied username to connect to container registry. </maml:para> </maml:Description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>PasswordEncrypted</maml:name> <maml:Description> <maml:para> Indicates that supplied container registry password is encrypted. </maml:para> </maml:Description> <command:parameterValue required="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-SFComposeDeploymentStatus</command:name> <command:verb>Get</command:verb> <command:noun>ComposeDeploymentStatus</command:noun> <maml:description> <maml:para>Gets information about a Service Fabric compose deployment.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Returns the status of the compose deployment that was created or in the process of being created in the Service Fabric cluster and whose name matches the one specified as the parameter. The response includes the name, status, and other details about the deployment.</maml:para> </maml:description> <command:parameters> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="0"> <maml:name>DeploymentName</maml:name> <maml:Description> <maml:para> The identity of the deployment. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-SFComposeDeploymentStatusList</command:name> <command:verb>Get</command:verb> <command:noun>ComposeDeploymentStatusList</command:noun> <maml:description> <maml:para>Gets the list of compose deployments created in the Service Fabric cluster.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Gets the status about the compose deployments that were created or in the process of being created in the Service Fabric cluster. The response includes the name, status, and other details about the compose deployments. If the list of deployments do not fit in a page, one page of results is returned as well as a continuation token, which can be used to get the next page.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" position="0"> <maml:name>MaxResults</maml:name> <maml:Description> <maml:para> The maximum number of results to be returned as part of the paged queries. This parameter defines the upper bound on the number of results returned. The results returned can be less than the specified maximum results if they do not fit in the message as per the max message size restrictions defined in the configuration. If this parameter is zero or not specified, the paged query includes as many results as possible that fit in the return message. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-SFComposeDeploymentUpgradeProgress</command:name> <command:verb>Get</command:verb> <command:noun>ComposeDeploymentUpgradeProgress</command:noun> <maml:description> <maml:para>Gets details for the latest upgrade performed on this Service Fabric compose deployment.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Returns the information about the state of the compose deployment upgrade along with details to aid debugging application health issues.</maml:para> </maml:description> <command:parameters> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="0"> <maml:name>DeploymentName</maml:name> <maml:Description> <maml:para> The identity of the deployment. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-SFComposeDeployment</command:name> <command:verb>Remove</command:verb> <command:noun>ComposeDeployment</command:noun> <maml:description> <maml:para>Deletes an existing Service Fabric compose deployment from cluster.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Deletes an existing Service Fabric compose deployment.</maml:para> </maml:description> <command:parameters> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="0"> <maml:name>DeploymentName</maml:name> <maml:Description> <maml:para> The identity of the deployment. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Start-SFComposeDeploymentUpgrade</command:name> <command:verb>Start</command:verb> <command:noun>ComposeDeploymentUpgrade</command:noun> <maml:description> <maml:para>Starts upgrading a compose deployment in the Service Fabric cluster.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Validates the supplied upgrade parameters and starts upgrading the deployment if the parameters are valid.</maml:para> </maml:description> <command:parameters> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="0"> <maml:name>DeploymentName</maml:name> <maml:Description> <maml:para> The identity of the deployment. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="1"> <maml:name>DeploymentName</maml:name> <maml:Description> <maml:para> The name of the deployment. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>ComposeFileContent</maml:name> <maml:Description> <maml:para> The content of the compose file that describes the deployment to create. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="3"> <maml:name>UpgradeKind</maml:name> <maml:Description> <maml:para> The kind of upgrade out of the following possible values. Possible values include: 'Invalid', 'Rolling' </maml:para> </maml:Description> <command:parameterValue required="true">UpgradeKind?</command:parameterValue> <dev:type> <maml:name>UpgradeKind?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>RegistryUserName</maml:name> <maml:Description> <maml:para> The user name to connect to container registry. </maml:para> </maml:Description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>RegistryPassword</maml:name> <maml:Description> <maml:para> The password for supplied username to connect to container registry. </maml:para> </maml:Description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>PasswordEncrypted</maml:name> <maml:Description> <maml:para> Indicates that supplied container registry password is encrypted. </maml:para> </maml:Description> <command:parameterValue required="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>RollingUpgradeMode</maml:name> <maml:Description> <maml:para> The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, and Monitored. Possible values include: 'Invalid', 'UnmonitoredAuto', 'UnmonitoredManual', 'Monitored' </maml:para> </maml:Description> <command:parameterValue required="false">UpgradeMode?</command:parameterValue> <dev:type> <maml:name>UpgradeMode?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>UpgradeReplicaSetCheckTimeoutInSeconds</maml:name> <maml:Description> <maml:para> The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. Valid values are between 0 and 42949672925 inclusive. (unsigned 32-bit integer). </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>ForceRestart</maml:name> <maml:Description> <maml:para> If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data). </maml:para> </maml:Description> <command:parameterValue required="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>FailureAction</maml:name> <maml:Description> <maml:para> The compensating action to perform when a Monitored upgrade encounters monitoring policy or health policy violations. Invalid indicates the failure action is invalid. Rollback specifies that the upgrade will start rolling back automatically. Manual indicates that the upgrade will switch to UnmonitoredManual upgrade mode. . Possible values include: 'Invalid', 'Rollback', 'Manual' </maml:para> </maml:Description> <command:parameterValue required="false">FailureAction?</command:parameterValue> <dev:type> <maml:name>FailureAction?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>HealthCheckWaitDurationInMilliseconds</maml:name> <maml:Description> <maml:para> The amount of time to wait after completing an upgrade domain before applying health policies. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds. </maml:para> </maml:Description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>HealthCheckStableDurationInMilliseconds</maml:name> <maml:Description> <maml:para> The amount of time that the application or cluster must remain healthy before the upgrade proceeds to the next upgrade domain. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds. </maml:para> </maml:Description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>HealthCheckRetryTimeoutInMilliseconds</maml:name> <maml:Description> <maml:para> The amount of time to retry health evaluation when the application or cluster is unhealthy before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds. </maml:para> </maml:Description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>UpgradeTimeoutInMilliseconds</maml:name> <maml:Description> <maml:para> The amount of time the overall upgrade has to complete before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds. </maml:para> </maml:Description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>UpgradeDomainTimeoutInMilliseconds</maml:name> <maml:Description> <maml:para> The amount of time each upgrade domain has to complete before FailureAction is executed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds. </maml:para> </maml:Description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>ConsiderWarningAsError</maml:name> <maml:Description> <maml:para> Indicates whether warnings are treated with the same severity as errors. </maml:para> </maml:Description> <command:parameterValue required="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>MaxPercentUnhealthyDeployedApplications</maml:name> <maml:Description> <maml:para> The maximum allowed percentage of unhealthy deployed applications. Allowed values are Byte values from zero to 100. The percentage represents the maximum tolerated percentage of deployed applications that can be unhealthy before the application is considered in error. This is calculated by dividing the number of unhealthy deployed applications over the number of nodes where the application is currently deployed on in the cluster. The computation rounds up to tolerate one failure on small numbers of nodes. Default percentage is zero. </maml:para> </maml:Description> <command:parameterValue required="false">int?</command:parameterValue> <dev:type> <maml:name>int?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>MaxPercentUnhealthyPartitionsPerService</maml:name> <maml:Description> <maml:para> The maximum allowed percentage of unhealthy partitions per service. Allowed values are Byte values from zero to 100 The percentage represents the maximum tolerated percentage of partitions that can be unhealthy before the service is considered in error. If the percentage is respected but there is at least one unhealthy partition, the health is evaluated as Warning. The percentage is calculated by dividing the number of unhealthy partitions over the total number of partitions in the service. The computation rounds up to tolerate one failure on small numbers of partitions. Default percentage is zero. </maml:para> </maml:Description> <command:parameterValue required="false">int?</command:parameterValue> <dev:type> <maml:name>int?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="19"> <maml:name>MaxPercentUnhealthyReplicasPerPartition</maml:name> <maml:Description> <maml:para> The maximum allowed percentage of unhealthy replicas per partition. Allowed values are Byte values from zero to 100. The percentage represents the maximum tolerated percentage of replicas that can be unhealthy before the partition is considered in error. If the percentage is respected but there is at least one unhealthy replica, the health is evaluated as Warning. The percentage is calculated by dividing the number of unhealthy replicas over the total number of replicas in the partition. The computation rounds up to tolerate one failure on small numbers of replicas. Default percentage is zero. </maml:para> </maml:Description> <command:parameterValue required="false">int?</command:parameterValue> <dev:type> <maml:name>int?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="20"> <maml:name>MaxPercentUnhealthyServices</maml:name> <maml:Description> <maml:para> The maximum allowed percentage of unhealthy services. Allowed values are Byte values from zero to 100. The percentage represents the maximum tolerated percentage of services that can be unhealthy before the application is considered in error. If the percentage is respected but there is at least one unhealthy service, the health is evaluated as Warning. This is calculated by dividing the number of unhealthy services of the specific service type over the total number of services of the specific service type. The computation rounds up to tolerate one failure on small numbers of services. Default percentage is zero. </maml:para> </maml:Description> <command:parameterValue required="false">int?</command:parameterValue> <dev:type> <maml:name>int?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="21"> <maml:name>ServiceTypeHealthPolicyMap</maml:name> <maml:Description> <maml:para> The map with service type health policy per service type name. The map is empty by default. </maml:para> </maml:Description> <command:parameterValue required="false">IEnumerable<ServiceTypeHealthPolicyMapItem></command:parameterValue> <dev:type> <maml:name>IEnumerable<ServiceTypeHealthPolicyMapItem></maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="22"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Start-SFRollbackComposeDeploymentUpgrade</command:name> <command:verb>Start</command:verb> <command:noun>RollbackComposeDeploymentUpgrade</command:noun> <maml:description> <maml:para>Starts rolling back a compose deployment upgrade in the Service Fabric cluster.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Rollback a service fabric compose deployment upgrade.</maml:para> </maml:description> <command:parameters> <command:parameter required="true" position="0"> <maml:name>DeploymentName</maml:name> <maml:Description> <maml:para> The identity of the deployment. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-SFChaos</command:name> <command:verb>Get</command:verb> <command:noun>Chaos</command:noun> <maml:description> <maml:para>Get the status of Chaos.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Get the status of Chaos indicating whether or not Chaos is running, the Chaos parameters used for running Chaos and the status of the Chaos Schedule. </maml:para> </maml:description> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Start-SFChaos</command:name> <command:verb>Start</command:verb> <command:noun>Chaos</command:noun> <maml:description> <maml:para>Starts Chaos in the cluster.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>If Chaos is not already running in the cluster, it starts Chaos with the passed in Chaos parameters. If Chaos is already running when this call is made, the call fails with the error code FABRIC_E_CHAOS_ALREADY_RUNNING. Refer to the article [Induce controlled Chaos in Service Fabric clusters](https://docs.microsoft.com/azure/service-fabric/service-fabric-controlled-chaos) for more details. </maml:para> </maml:description> <command:parameters> <command:parameter required="false" position="0"> <maml:name>TimeToRunInSeconds</maml:name> <maml:Description> <maml:para> Total time (in seconds) for which Chaos will run before automatically stopping. The maximum allowed value is 4,294,967,295 (System.UInt32.MaxValue). </maml:para> </maml:Description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>MaxClusterStabilizationTimeoutInSeconds</maml:name> <maml:Description> <maml:para> The maximum amount of time to wait for all cluster entities to become stable and healthy. Chaos executes in iterations and at the start of each iteration it validates the health of cluster entities. During validation if a cluster entity is not stable and healthy within MaxClusterStabilizationTimeoutInSeconds, Chaos generates a validation failed event. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>MaxConcurrentFaults</maml:name> <maml:Description> <maml:para> MaxConcurrentFaults is the maximum number of concurrent faults induced per iteration. Chaos executes in iterations and two consecutive iterations are separated by a validation phase. The higher the concurrency, the more aggressive the injection of faults, leading to inducing more complex series of states to uncover bugs. The recommendation is to start with a value of 2 or 3 and to exercise caution while moving up. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>EnableMoveReplicaFaults</maml:name> <maml:Description> <maml:para> Enables or disables the move primary and move secondary faults. </maml:para> </maml:Description> <command:parameterValue required="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>WaitTimeBetweenFaultsInSeconds</maml:name> <maml:Description> <maml:para> Wait time (in seconds) between consecutive faults within a single iteration. The larger the value, the lower the overlapping between faults and the simpler the sequence of state transitions that the cluster goes through. The recommendation is to start with a value between 1 and 5 and exercise caution while moving up. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>WaitTimeBetweenIterationsInSeconds</maml:name> <maml:Description> <maml:para> Time-separation (in seconds) between two consecutive iterations of Chaos. The larger the value, the lower the fault injection rate. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>ConsiderWarningAsError</maml:name> <maml:Description> <maml:para> Indicates whether warnings are treated with the same severity as errors. </maml:para> </maml:Description> <command:parameterValue required="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>MaxPercentUnhealthyNodes</maml:name> <maml:Description> <maml:para> The maximum allowed percentage of unhealthy nodes before reporting an error. For example, to allow 10% of nodes to be unhealthy, this value would be 10. The percentage represents the maximum tolerated percentage of nodes that can be unhealthy before the cluster is considered in error. If the percentage is respected but there is at least one unhealthy node, the health is evaluated as Warning. The percentage is calculated by dividing the number of unhealthy nodes over the total number of nodes in the cluster. The computation rounds up to tolerate one failure on small numbers of nodes. Default percentage is zero. In large clusters, some nodes will always be down or out for repairs, so this percentage should be configured to tolerate that. </maml:para> </maml:Description> <command:parameterValue required="false">int?</command:parameterValue> <dev:type> <maml:name>int?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>MaxPercentUnhealthyApplications</maml:name> <maml:Description> <maml:para> The maximum allowed percentage of unhealthy applications before reporting an error. For example, to allow 10% of applications to be unhealthy, this value would be 10. The percentage represents the maximum tolerated percentage of applications that can be unhealthy before the cluster is considered in error. If the percentage is respected but there is at least one unhealthy application, the health is evaluated as Warning. This is calculated by dividing the number of unhealthy applications over the total number of application instances in the cluster, excluding applications of application types that are included in the ApplicationTypeHealthPolicyMap. The computation rounds up to tolerate one failure on small numbers of applications. Default percentage is zero. </maml:para> </maml:Description> <command:parameterValue required="false">int?</command:parameterValue> <dev:type> <maml:name>int?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>ApplicationTypeHealthPolicyMap</maml:name> <maml:Description> <maml:para> Defines a map with max percentage unhealthy applications for specific application types. Each entry specifies as key the application type name and as value an integer that represents the MaxPercentUnhealthyApplications percentage used to evaluate the applications of the specified application type. The application type health policy map can be used during cluster health evaluation to describe special application types. The application types included in the map are evaluated against the percentage specified in the map, and not with the global MaxPercentUnhealthyApplications defined in the cluster health policy. The applications of application types specified in the map are not counted against the global pool of applications. For example, if some applications of a type are critical, the cluster administrator can add an entry to the map for that application type and assign it a value of 0% (that is, do not tolerate any failures). All other applications can be evaluated with MaxPercentUnhealthyApplications set to 20% to tolerate some failures out of the thousands of application instances. The application type health policy map is used only if the cluster manifest enables application type health evaluation using the configuration entry for HealthManager/EnableApplicationTypeHealthEvaluation. </maml:para> </maml:Description> <command:parameterValue required="false">IEnumerable<ApplicationTypeHealthPolicyMapItem></command:parameterValue> <dev:type> <maml:name>IEnumerable<ApplicationTypeHealthPolicyMapItem></maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>Map</maml:name> <maml:Description> <maml:para> Describes a map that contains a collection of ChaosContextMapItem's. </maml:para> </maml:Description> <command:parameterValue required="false">IReadOnlyDictionary<string, string></command:parameterValue> <dev:type> <maml:name>IReadOnlyDictionary<string, string></maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>NodeTypeInclusionList</maml:name> <maml:Description> <maml:para> A list of node types to include in Chaos faults. All types of faults (restart node, restart code package, remove replica, restart replica, move primary, and move secondary) are enabled for the nodes of these node types. If a node type (say NodeTypeX) does not appear in the NodeTypeInclusionList, then node level faults (like NodeRestart) will never be enabled for the nodes of NodeTypeX, but code package and replica faults can still be enabled for NodeTypeX if an application in the ApplicationInclusionList. happens to reside on a node of NodeTypeX. At most 100 node type names can be included in this list, to increase this number, a config upgrade is required for MaxNumberOfNodeTypesInChaosEntityFilter configuration. </maml:para> </maml:Description> <command:parameterValue required="false">IEnumerable<string></command:parameterValue> <dev:type> <maml:name>IEnumerable<string></maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>ApplicationInclusionList</maml:name> <maml:Description> <maml:para> A list of application URIs to include in Chaos faults. All replicas belonging to services of these applications are amenable to replica faults (restart replica, remove replica, move primary, and move secondary) by Chaos. Chaos may restart a code package only if the code package hosts replicas of these applications only. If an application does not appear in this list, it can still be faulted in some Chaos iteration if the application ends up on a node of a node type that is included in NodeTypeInclusionList. However, if applicationX is tied to nodeTypeY through placement constraints and applicationX is absent from ApplicationInclusionList and nodeTypeY is absent from NodeTypeInclusionList, then applicationX will never be faulted. At most 1000 application names can be included in this list, to increase this number, a config upgrade is required for MaxNumberOfApplicationsInChaosEntityFilter configuration. </maml:para> </maml:Description> <command:parameterValue required="false">IEnumerable<string></command:parameterValue> <dev:type> <maml:name>IEnumerable<string></maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Stop-SFChaos</command:name> <command:verb>Stop</command:verb> <command:noun>Chaos</command:noun> <maml:description> <maml:para>Stops Chaos if it is running in the cluster and put the Chaos Schedule in a stopped state.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Stops Chaos from executing new faults. In-flight faults will continue to execute until they are complete. The current Chaos Schedule is put into a stopped state. Once a schedule is stopped, it will stay in the stopped state and not be used to Chaos Schedule new runs of Chaos. A new Chaos Schedule must be set in order to resume scheduling. </maml:para> </maml:description> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-SFChaosEvents</command:name> <command:verb>Get</command:verb> <command:noun>ChaosEvents</command:noun> <maml:description> <maml:para>Gets the next segment of the Chaos events based on the continuation token or the time range.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>To get the next segment of the Chaos events, you can specify the ContinuationToken. To get the start of a new segment of Chaos events, you can specify the time range through StartTimeUtc and EndTimeUtc. You cannot specify both the ContinuationToken and the time range in the same call. When there are more than 100 Chaos events, the Chaos events are returned in multiple segments where a segment contains no more than 100 Chaos events and to get the next segment you make a call to this API with the continuation token. </maml:para> </maml:description> <command:parameters> <command:parameter required="false" position="0"> <maml:name>StartTimeUtc</maml:name> <maml:Description> <maml:para> The Windows file time representing the start time of the time range for which a Chaos report is to be generated. Consult [DateTime.ToFileTimeUtc Method](https://msdn.microsoft.com/library/system.datetime.tofiletimeutc(v=vs.110).aspx) for details. </maml:para> </maml:Description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>EndTimeUtc</maml:name> <maml:Description> <maml:para> The Windows file time representing the end time of the time range for which a Chaos report is to be generated. Consult [DateTime.ToFileTimeUtc Method](https://msdn.microsoft.com/library/system.datetime.tofiletimeutc(v=vs.110).aspx) for details. </maml:para> </maml:Description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>MaxResults</maml:name> <maml:Description> <maml:para> The maximum number of results to be returned as part of the paged queries. This parameter defines the upper bound on the number of results returned. The results returned can be less than the specified maximum results if they do not fit in the message as per the max message size restrictions defined in the configuration. If this parameter is zero or not specified, the paged query includes as many results as possible that fit in the return message. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-SFChaosSchedule</command:name> <command:verb>Get</command:verb> <command:noun>ChaosSchedule</command:noun> <maml:description> <maml:para>Get the Chaos Schedule defining when and how to run Chaos.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Gets the version of the Chaos Schedule in use and the Chaos Schedule that defines when and how to run Chaos. </maml:para> </maml:description> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-SFChaosSchedule</command:name> <command:verb>New</command:verb> <command:noun>ChaosSchedule</command:noun> <maml:description> <maml:para>Set the schedule used by Chaos.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Chaos will automatically schedule runs based on the Chaos Schedule. The Chaos Schedule will be updated if the provided version matches the version on the server. When updating the Chaos Schedule, the version on the server is incremented by 1. The version on the server will wrap back to 0 after reaching a large number. If Chaos is running when this call is made, the call will fail. </maml:para> </maml:description> <command:parameters> <command:parameter required="false" position="0"> <maml:name>Version</maml:name> <maml:Description> <maml:para> The version number of the Schedule. </maml:para> </maml:Description> <command:parameterValue required="false">int?</command:parameterValue> <dev:type> <maml:name>int?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>StartDate</maml:name> <maml:Description> <maml:para> The date and time Chaos will start using this schedule. </maml:para> </maml:Description> <command:parameterValue required="false">DateTime?</command:parameterValue> <dev:type> <maml:name>DateTime?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ExpiryDate</maml:name> <maml:Description> <maml:para> The date and time Chaos will continue to use this schedule until. </maml:para> </maml:Description> <command:parameterValue required="false">DateTime?</command:parameterValue> <dev:type> <maml:name>DateTime?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>ChaosParametersDictionary</maml:name> <maml:Description> <maml:para> A mapping of string names to Chaos Parameters to be referenced by Chaos Schedule Jobs. </maml:para> </maml:Description> <command:parameterValue required="false">IEnumerable<ChaosParametersDictionaryItem></command:parameterValue> <dev:type> <maml:name>IEnumerable<ChaosParametersDictionaryItem></maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Jobs</maml:name> <maml:Description> <maml:para> A list of all Chaos Schedule Jobs that will be automated by the schedule. </maml:para> </maml:Description> <command:parameterValue required="false">IEnumerable<ChaosScheduleJob></command:parameterValue> <dev:type> <maml:name>IEnumerable<ChaosScheduleJob></maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-SFImageStoreContent</command:name> <command:verb>Get</command:verb> <command:noun>ImageStoreContent</command:noun> <maml:description> <maml:para>Gets the image store content information.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Returns the information about the image store content at the specified contentPath. The contentPath is relative to the root of the image store.</maml:para> </maml:description> <command:parameters> <command:parameter required="true" position="0"> <maml:name>ContentPath</maml:name> <maml:Description> <maml:para> Relative path to file or folder in the image store from its root. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-SFImageStoreContent</command:name> <command:verb>Remove</command:verb> <command:noun>ImageStoreContent</command:noun> <maml:description> <maml:para>Deletes existing image store content.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Deletes existing image store content being found within the given image store relative path. This command can be used to delete uploaded application packages once they are provisioned.</maml:para> </maml:description> <command:parameters> <command:parameter required="true" position="0"> <maml:name>ContentPath</maml:name> <maml:Description> <maml:para> Relative path to file or folder in the image store from its root. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-SFImageStoreRootContent</command:name> <command:verb>Get</command:verb> <command:noun>ImageStoreRootContent</command:noun> <maml:description> <maml:para>Gets the content information at the root of the image store.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Returns the information about the image store content at the root of the image store.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Copy-SFImageStoreContent</command:name> <command:verb>Copy</command:verb> <command:noun>ImageStoreContent</command:noun> <maml:description> <maml:para>Copies image store content internally</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Copies the image store content from the source image store relative path to the destination image store relative path.</maml:para> </maml:description> <command:parameters> <command:parameter required="true" position="0"> <maml:name>RemoteSource</maml:name> <maml:Description> <maml:para> The relative path of source image store content to be copied from. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>RemoteDestination</maml:name> <maml:Description> <maml:para> The relative path of destination image store content to be copied to. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>SkipFiles</maml:name> <maml:Description> <maml:para> The list of the file names to be skipped for copying. </maml:para> </maml:Description> <command:parameterValue required="false">IEnumerable<string></command:parameterValue> <dev:type> <maml:name>IEnumerable<string></maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>CheckMarkFile</maml:name> <maml:Description> <maml:para> Indicates whether to check mark file during copying. The property is true if checking mark file is required, false otherwise. The mark file is used to check whether the folder is well constructed. If the property is true and mark file does not exist, the copy is skipped. </maml:para> </maml:Description> <command:parameterValue required="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-SFImageStoreUploadSession</command:name> <command:verb>Remove</command:verb> <command:noun>ImageStoreUploadSession</command:noun> <maml:description> <maml:para>Cancels an image store upload session.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>The DELETE request will cause the existing upload session to expire and remove any previously uploaded file chunks. </maml:para> </maml:description> <command:parameters> <command:parameter required="true" position="0"> <maml:name>SessionId</maml:name> <maml:Description> <maml:para> A GUID generated by the user for a file uploading. It identifies an image store upload session which keeps track of all file chunks until it is committed. </maml:para> </maml:Description> <command:parameterValue required="true">Guid?</command:parameterValue> <dev:type> <maml:name>Guid?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-SFImageStoreUploadSession</command:name> <command:verb>New</command:verb> <command:noun>ImageStoreUploadSession</command:noun> <maml:description> <maml:para>Commit an image store upload session.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>When all file chunks have been uploaded, the upload session needs to be committed explicitly to complete the upload. Image store preserves the upload session until the expiration time, which is 30 minutes after the last chunk received. </maml:para> </maml:description> <command:parameters> <command:parameter required="true" position="0"> <maml:name>SessionId</maml:name> <maml:Description> <maml:para> A GUID generated by the user for a file uploading. It identifies an image store upload session which keeps track of all file chunks until it is committed. </maml:para> </maml:Description> <command:parameterValue required="true">Guid?</command:parameterValue> <dev:type> <maml:name>Guid?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-SFImageStoreUploadSessionById</command:name> <command:verb>Get</command:verb> <command:noun>ImageStoreUploadSessionById</command:noun> <maml:description> <maml:para>Get the image store upload session by ID.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Gets the image store upload session identified by the given ID. User can query the upload session at any time during uploading. </maml:para> </maml:description> <command:parameters> <command:parameter required="true" position="0"> <maml:name>SessionId</maml:name> <maml:Description> <maml:para> A GUID generated by the user for a file uploading. It identifies an image store upload session which keeps track of all file chunks until it is committed. </maml:para> </maml:Description> <command:parameterValue required="true">Guid?</command:parameterValue> <dev:type> <maml:name>Guid?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-SFImageStoreUploadSessionByPath</command:name> <command:verb>Get</command:verb> <command:noun>ImageStoreUploadSessionByPath</command:noun> <maml:description> <maml:para>Get the image store upload session by relative path.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Gets the image store upload session associated with the given image store relative path. User can query the upload session at any time during uploading. </maml:para> </maml:description> <command:parameters> <command:parameter required="true" position="0"> <maml:name>ContentPath</maml:name> <maml:Description> <maml:para> Relative path to file or folder in the image store from its root. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-SFImageStoreRootFolderSize</command:name> <command:verb>Get</command:verb> <command:noun>ImageStoreRootFolderSize</command:noun> <maml:description> <maml:para>Get the folder size at the root of the image store.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Returns the total size of files at the root and children folders in image store.</maml:para> </maml:description> <command:parameters> <command:parameter required="false" position="0"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-SFImageStoreFolderSize</command:name> <command:verb>Get</command:verb> <command:noun>ImageStoreFolderSize</command:noun> <maml:description> <maml:para>Get the size of a folder in image store</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Gets the total size of file under a image store folder, specified by contentPath. The contentPath is relative to the root of the image store. </maml:para> </maml:description> <command:parameters> <command:parameter required="true" position="0"> <maml:name>ContentPath</maml:name> <maml:Description> <maml:para> Relative path to file or folder in the image store from its root. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-SFInfrastructureCommand</command:name> <command:verb>New</command:verb> <command:noun>InfrastructureCommand</command:noun> <maml:description> <maml:para>Invokes an administrative command on the given Infrastructure Service instance.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>For clusters that have one or more instances of the Infrastructure Service configured, this API provides a way to send infrastructure-specific commands to a particular instance of the Infrastructure Service. Available commands and their corresponding response formats vary depending upon the infrastructure on which the cluster is running. This API supports the Service Fabric platform; it is not meant to be used directly from your code. </maml:para> </maml:description> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Command</maml:name> <maml:Description> <maml:para> The text of the command to be invoked. The content of the command is infrastructure-specific. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ServiceId</maml:name> <maml:Description> <maml:para> The identity of the infrastructure service. This is the full name of the infrastructure service without the 'fabric:' URI scheme. This parameter required only for the cluster that has more than one instance of infrastructure service running. </maml:para> </maml:Description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-SFInfrastructureQuery</command:name> <command:verb>New</command:verb> <command:noun>InfrastructureQuery</command:noun> <maml:description> <maml:para>Invokes a read-only query on the given infrastructure service instance.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>For clusters that have one or more instances of the Infrastructure Service configured, this API provides a way to send infrastructure-specific queries to a particular instance of the Infrastructure Service. Available commands and their corresponding response formats vary depending upon the infrastructure on which the cluster is running. This API supports the Service Fabric platform; it is not meant to be used directly from your code. </maml:para> </maml:description> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Command</maml:name> <maml:Description> <maml:para> The text of the command to be invoked. The content of the command is infrastructure-specific. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ServiceId</maml:name> <maml:Description> <maml:para> The identity of the infrastructure service. This is the full name of the infrastructure service without the 'fabric:' URI scheme. This parameter required only for the cluster that has more than one instance of infrastructure service running. </maml:para> </maml:Description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Start-SFDataLoss</command:name> <command:verb>Start</command:verb> <command:noun>DataLoss</command:noun> <maml:description> <maml:para>This API will induce data loss for the specified partition. It will trigger a call to the OnDataLossAsync API of the partition.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>This API will induce data loss for the specified partition. It will trigger a call to the OnDataLoss API of the partition. Actual data loss will depend on the specified DataLossMode. - PartialDataLoss - Only a quorum of replicas are removed and OnDataLoss is triggered for the partition but actual data loss depends on the presence of in-flight replication. - FullDataLoss - All replicas are removed hence all data is lost and OnDataLoss is triggered. This API should only be called with a stateful service as the target. Calling this API with a system service as the target is not advised. Note: Once this API has been called, it cannot be reversed. Calling CancelOperation will only stop execution and clean up internal system state. It will not restore data if the command has progressed far enough to cause data loss. Call the GetDataLossProgress API with the same OperationId to return information on the operation started with this API. </maml:para> </maml:description> <command:parameters> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="0"> <maml:name>ServiceId</maml:name> <maml:Description> <maml:para> The identity of the service. This ID is typically the full name of the service without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the service name is "fabric:/myapp/app1/svc1", the service identity would be "myapp~app1~svc1" in 6.0+ and "myapp/app1/svc1" in previous versions. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="1"> <maml:name>PartitionId</maml:name> <maml:Description> <maml:para> The identity of the partition. </maml:para> </maml:Description> <command:parameterValue required="true">PartitionId</command:parameterValue> <dev:type> <maml:name>PartitionId</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>OperationId</maml:name> <maml:Description> <maml:para> A GUID that identifies a call of this API. This is passed into the corresponding GetProgress API </maml:para> </maml:Description> <command:parameterValue required="true">Guid?</command:parameterValue> <dev:type> <maml:name>Guid?</maml:name> </dev:type> </command:parameter> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="3"> <maml:name>DataLossMode</maml:name> <maml:Description> <maml:para> This enum is passed to the StartDataLoss API to indicate what type of data loss to induce. Possible values include: 'Invalid', 'PartialDataLoss', 'FullDataLoss' </maml:para> </maml:Description> <command:parameterValue required="true">DataLossMode?</command:parameterValue> <dev:type> <maml:name>DataLossMode?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-SFDataLossProgress</command:name> <command:verb>Get</command:verb> <command:noun>DataLossProgress</command:noun> <maml:description> <maml:para>Gets the progress of a partition data loss operation started using the StartDataLoss API.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Gets the progress of a data loss operation started with StartDataLoss, using the OperationId. </maml:para> </maml:description> <command:parameters> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="0"> <maml:name>ServiceId</maml:name> <maml:Description> <maml:para> The identity of the service. This ID is typically the full name of the service without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the service name is "fabric:/myapp/app1/svc1", the service identity would be "myapp~app1~svc1" in 6.0+ and "myapp/app1/svc1" in previous versions. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="1"> <maml:name>PartitionId</maml:name> <maml:Description> <maml:para> The identity of the partition. </maml:para> </maml:Description> <command:parameterValue required="true">PartitionId</command:parameterValue> <dev:type> <maml:name>PartitionId</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>OperationId</maml:name> <maml:Description> <maml:para> A GUID that identifies a call of this API. This is passed into the corresponding GetProgress API </maml:para> </maml:Description> <command:parameterValue required="true">Guid?</command:parameterValue> <dev:type> <maml:name>Guid?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Start-SFQuorumLoss</command:name> <command:verb>Start</command:verb> <command:noun>QuorumLoss</command:noun> <maml:description> <maml:para>Induces quorum loss for a given stateful service partition.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>This API is useful for a temporary quorum loss situation on your service. Call the GetQuorumLossProgress API with the same OperationId to return information on the operation started with this API. This can only be called on stateful persisted (HasPersistedState==true) services. Do not use this API on stateless services or stateful in-memory only services. </maml:para> </maml:description> <command:parameters> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="0"> <maml:name>ServiceId</maml:name> <maml:Description> <maml:para> The identity of the service. This ID is typically the full name of the service without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the service name is "fabric:/myapp/app1/svc1", the service identity would be "myapp~app1~svc1" in 6.0+ and "myapp/app1/svc1" in previous versions. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="1"> <maml:name>PartitionId</maml:name> <maml:Description> <maml:para> The identity of the partition. </maml:para> </maml:Description> <command:parameterValue required="true">PartitionId</command:parameterValue> <dev:type> <maml:name>PartitionId</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>OperationId</maml:name> <maml:Description> <maml:para> A GUID that identifies a call of this API. This is passed into the corresponding GetProgress API </maml:para> </maml:Description> <command:parameterValue required="true">Guid?</command:parameterValue> <dev:type> <maml:name>Guid?</maml:name> </dev:type> </command:parameter> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="3"> <maml:name>QuorumLossMode</maml:name> <maml:Description> <maml:para> This enum is passed to the StartQuorumLoss API to indicate what type of quorum loss to induce. Possible values include: 'Invalid', 'QuorumReplicas', 'AllReplicas' </maml:para> </maml:Description> <command:parameterValue required="true">QuorumLossMode?</command:parameterValue> <dev:type> <maml:name>QuorumLossMode?</maml:name> </dev:type> </command:parameter> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="4"> <maml:name>QuorumLossDuration</maml:name> <maml:Description> <maml:para> The amount of time for which the partition will be kept in quorum loss. This must be specified in seconds. </maml:para> </maml:Description> <command:parameterValue required="true">int?</command:parameterValue> <dev:type> <maml:name>int?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-SFQuorumLossProgress</command:name> <command:verb>Get</command:verb> <command:noun>QuorumLossProgress</command:noun> <maml:description> <maml:para>Gets the progress of a quorum loss operation on a partition started using the StartQuorumLoss API.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Gets the progress of a quorum loss operation started with StartQuorumLoss, using the provided OperationId. </maml:para> </maml:description> <command:parameters> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="0"> <maml:name>ServiceId</maml:name> <maml:Description> <maml:para> The identity of the service. This ID is typically the full name of the service without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the service name is "fabric:/myapp/app1/svc1", the service identity would be "myapp~app1~svc1" in 6.0+ and "myapp/app1/svc1" in previous versions. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="1"> <maml:name>PartitionId</maml:name> <maml:Description> <maml:para> The identity of the partition. </maml:para> </maml:Description> <command:parameterValue required="true">PartitionId</command:parameterValue> <dev:type> <maml:name>PartitionId</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>OperationId</maml:name> <maml:Description> <maml:para> A GUID that identifies a call of this API. This is passed into the corresponding GetProgress API </maml:para> </maml:Description> <command:parameterValue required="true">Guid?</command:parameterValue> <dev:type> <maml:name>Guid?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Start-SFPartitionRestart</command:name> <command:verb>Start</command:verb> <command:noun>PartitionRestart</command:noun> <maml:description> <maml:para>This API will restart some or all replicas or instances of the specified partition.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>This API is useful for testing failover. If used to target a stateless service partition, RestartPartitionMode must be AllReplicasOrInstances. Call the GetPartitionRestartProgress API using the same OperationId to get the progress. </maml:para> </maml:description> <command:parameters> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="0"> <maml:name>ServiceId</maml:name> <maml:Description> <maml:para> The identity of the service. This ID is typically the full name of the service without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the service name is "fabric:/myapp/app1/svc1", the service identity would be "myapp~app1~svc1" in 6.0+ and "myapp/app1/svc1" in previous versions. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="1"> <maml:name>PartitionId</maml:name> <maml:Description> <maml:para> The identity of the partition. </maml:para> </maml:Description> <command:parameterValue required="true">PartitionId</command:parameterValue> <dev:type> <maml:name>PartitionId</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>OperationId</maml:name> <maml:Description> <maml:para> A GUID that identifies a call of this API. This is passed into the corresponding GetProgress API </maml:para> </maml:Description> <command:parameterValue required="true">Guid?</command:parameterValue> <dev:type> <maml:name>Guid?</maml:name> </dev:type> </command:parameter> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="3"> <maml:name>RestartPartitionMode</maml:name> <maml:Description> <maml:para> Describe which partitions to restart. Possible values include: 'Invalid', 'AllReplicasOrInstances', 'OnlyActiveSecondaries' </maml:para> </maml:Description> <command:parameterValue required="true">RestartPartitionMode?</command:parameterValue> <dev:type> <maml:name>RestartPartitionMode?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-SFPartitionRestartProgress</command:name> <command:verb>Get</command:verb> <command:noun>PartitionRestartProgress</command:noun> <maml:description> <maml:para>Gets the progress of a PartitionRestart operation started using StartPartitionRestart.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Gets the progress of a PartitionRestart started with StartPartitionRestart using the provided OperationId. </maml:para> </maml:description> <command:parameters> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="0"> <maml:name>ServiceId</maml:name> <maml:Description> <maml:para> The identity of the service. This ID is typically the full name of the service without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the service name is "fabric:/myapp/app1/svc1", the service identity would be "myapp~app1~svc1" in 6.0+ and "myapp/app1/svc1" in previous versions. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="1"> <maml:name>PartitionId</maml:name> <maml:Description> <maml:para> The identity of the partition. </maml:para> </maml:Description> <command:parameterValue required="true">PartitionId</command:parameterValue> <dev:type> <maml:name>PartitionId</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>OperationId</maml:name> <maml:Description> <maml:para> A GUID that identifies a call of this API. This is passed into the corresponding GetProgress API </maml:para> </maml:Description> <command:parameterValue required="true">Guid?</command:parameterValue> <dev:type> <maml:name>Guid?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Start-SFNodeTransition</command:name> <command:verb>Start</command:verb> <command:noun>NodeTransition</command:noun> <maml:description> <maml:para>Starts or stops a cluster node.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Starts or stops a cluster node. A cluster node is a process, not the OS instance itself. To start a node, pass in "Start" for the NodeTransitionType parameter. To stop a node, pass in "Stop" for the NodeTransitionType parameter. This API starts the operation - when the API returns the node may not have finished transitioning yet. Call GetNodeTransitionProgress with the same OperationId to get the progress of the operation. </maml:para> </maml:description> <command:parameters> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="0"> <maml:name>NodeName</maml:name> <maml:Description> <maml:para> The name of the node. </maml:para> </maml:Description> <command:parameterValue required="true">NodeName</command:parameterValue> <dev:type> <maml:name>NodeName</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>OperationId</maml:name> <maml:Description> <maml:para> A GUID that identifies a call of this API. This is passed into the corresponding GetProgress API </maml:para> </maml:Description> <command:parameterValue required="true">Guid?</command:parameterValue> <dev:type> <maml:name>Guid?</maml:name> </dev:type> </command:parameter> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="2"> <maml:name>NodeTransitionType</maml:name> <maml:Description> <maml:para> Indicates the type of transition to perform. NodeTransitionType.Start will start a stopped node. NodeTransitionType.Stop will stop a node that is up. Possible values include: 'Invalid', 'Start', 'Stop' </maml:para> </maml:Description> <command:parameterValue required="true">NodeTransitionType?</command:parameterValue> <dev:type> <maml:name>NodeTransitionType?</maml:name> </dev:type> </command:parameter> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="3"> <maml:name>NodeInstanceId</maml:name> <maml:Description> <maml:para> The node instance ID of the target node. This can be determined through GetNodeInfo API. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="4"> <maml:name>StopDurationInSeconds</maml:name> <maml:Description> <maml:para> The duration, in seconds, to keep the node stopped. The minimum value is 600, the maximum is 14400. After this time expires, the node will automatically come back up. </maml:para> </maml:Description> <command:parameterValue required="true">int?</command:parameterValue> <dev:type> <maml:name>int?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-SFNodeTransitionProgress</command:name> <command:verb>Get</command:verb> <command:noun>NodeTransitionProgress</command:noun> <maml:description> <maml:para>Gets the progress of an operation started using StartNodeTransition.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Gets the progress of an operation started with StartNodeTransition using the provided OperationId. </maml:para> </maml:description> <command:parameters> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="0"> <maml:name>NodeName</maml:name> <maml:Description> <maml:para> The name of the node. </maml:para> </maml:Description> <command:parameterValue required="true">NodeName</command:parameterValue> <dev:type> <maml:name>NodeName</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>OperationId</maml:name> <maml:Description> <maml:para> A GUID that identifies a call of this API. This is passed into the corresponding GetProgress API </maml:para> </maml:Description> <command:parameterValue required="true">Guid?</command:parameterValue> <dev:type> <maml:name>Guid?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-SFFaultOperationList</command:name> <command:verb>Get</command:verb> <command:noun>FaultOperationList</command:noun> <maml:description> <maml:para>Gets a list of user-induced fault operations filtered by provided input.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Gets the list of user-induced fault operations filtered by provided input.</maml:para> </maml:description> <command:parameters> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="0"> <maml:name>TypeFilter</maml:name> <maml:Description> <maml:para> Used to filter on OperationType for user-induced operations. - 65535 - select all - 1 - select PartitionDataLoss. - 2 - select PartitionQuorumLoss. - 4 - select PartitionRestart. - 8 - select NodeTransition. </maml:para> </maml:Description> <command:parameterValue required="true">int?</command:parameterValue> <dev:type> <maml:name>int?</maml:name> </dev:type> </command:parameter> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="1"> <maml:name>StateFilter</maml:name> <maml:Description> <maml:para> 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 </maml:para> </maml:Description> <command:parameterValue required="true">int?</command:parameterValue> <dev:type> <maml:name>int?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Stop-SFOperation</command:name> <command:verb>Stop</command:verb> <command:noun>Operation</command:noun> <maml:description> <maml:para>Cancels a user-induced fault operation.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>The following APIs start fault operations that may be cancelled by using CancelOperation: StartDataLoss, StartQuorumLoss, StartPartitionRestart, StartNodeTransition. If force is false, then the specified user-induced operation will be gracefully stopped and cleaned up. If force is true, the command will be aborted, and some internal state may be left behind. Specifying force as true should be used with care. Calling this API with force set to true is not allowed until this API has already been called on the same test command with force set to false first, or unless the test command already has an OperationState of OperationState.RollingBack. Clarification: OperationState.RollingBack means that the system will be/is cleaning up internal system state caused by executing the command. It will not restore data if the test command was to cause data loss. For example, if you call StartDataLoss then call this API, the system will only clean up internal state from running the command. It will not restore the target partition's data, if the command progressed far enough to cause data loss. Important note: if this API is invoked with force==true, internal state may be left behind. </maml:para> </maml:description> <command:parameters> <command:parameter required="true" position="0"> <maml:name>OperationId</maml:name> <maml:Description> <maml:para> A GUID that identifies a call of this API. This is passed into the corresponding GetProgress API </maml:para> </maml:Description> <command:parameterValue required="true">Guid?</command:parameterValue> <dev:type> <maml:name>Guid?</maml:name> </dev:type> </command:parameter> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="1"> <maml:name>Force</maml:name> <maml:Description> <maml:para> Indicates whether to gracefully roll back and clean up internal system state modified by executing the user-induced operation. </maml:para> </maml:Description> <command:parameterValue required="true">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-SFBackupPolicy</command:name> <command:verb>New</command:verb> <command:noun>BackupPolicy</command:noun> <maml:description> <maml:para>Creates a backup policy.</maml:para> </maml:description> </command:details> <command:syntax> <command:syntaxItem> <maml:name>New-SFBackupPolicy</maml:name> <command:parameter required="true"> <maml:name>Interval</maml:name> </command:parameter> <command:parameter required="true"> <maml:name>ConnectionString</maml:name> </command:parameter> <command:parameter required="true"> <maml:name>ContainerName</maml:name> </command:parameter> <command:parameter required="true"> <maml:name>RetentionDuration</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>MinimumNumberOfBackups</maml:name> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-SFBackupPolicy</maml:name> <command:parameter required="true"> <maml:name>Interval</maml:name> </command:parameter> <command:parameter required="true"> <maml:name>Path</maml:name> </command:parameter> <command:parameter required="true"> <maml:name>RetentionDuration</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>PrimaryUserName</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>PrimaryPassword</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>SecondaryUserName</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>SecondaryPassword</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>MinimumNumberOfBackups</maml:name> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-SFBackupPolicy</maml:name> <command:parameter required="true"> <maml:name>ScheduleFrequencyType</maml:name> </command:parameter> <command:parameter required="true"> <maml:name>RunTimes</maml:name> </command:parameter> <command:parameter required="true"> <maml:name>ConnectionString</maml:name> </command:parameter> <command:parameter required="true"> <maml:name>ContainerName</maml:name> </command:parameter> <command:parameter required="true"> <maml:name>RetentionDuration</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>RunDays</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>MinimumNumberOfBackups</maml:name> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-SFBackupPolicy</maml:name> <command:parameter required="true"> <maml:name>ScheduleFrequencyType</maml:name> </command:parameter> <command:parameter required="true"> <maml:name>RunTimes</maml:name> </command:parameter> <command:parameter required="true"> <maml:name>Path</maml:name> </command:parameter> <command:parameter required="true"> <maml:name>RetentionDuration</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>RunDays</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>PrimaryUserName</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>PrimaryPassword</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>SecondaryUserName</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>SecondaryPassword</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>MinimumNumberOfBackups</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <maml:description> <maml:para>Creates a backup policy which can be associated later with a Service Fabric application, service or a partition for periodic backup. </maml:para> </maml:description> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Name</maml:name> <maml:Description> <maml:para> The unique name identifying this backup policy. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>AutoRestoreOnDataLoss</maml:name> <maml:Description> <maml:para> Specifies whether to trigger restore automatically using the latest available backup in case the partition experiences a data loss event. </maml:para> </maml:Description> <command:parameterValue required="true">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>MaxIncrementalBackups</maml:name> <maml:Description> <maml:para> Defines the maximum number of incremental backups to be taken between two full backups. This is just the upper limit. A full backup may be taken before specified number of incremental backups are completed in one of the following conditions - The replica has never taken a full backup since it has become primary, - Some of the log records since the last backup has been truncated, or - Replica passed the MaxAccumulatedBackupLogSizeInMB limit. </maml:para> </maml:Description> <command:parameterValue required="true">int?</command:parameterValue> <dev:type> <maml:name>int?</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="3"> <maml:name>Interval</maml:name> <maml:Description> <maml:para> Defines the interval with which backups are periodically taken. It should be specified in ISO8601 format. Timespan in seconds is not supported and will be ignored while creating the policy. </maml:para> </maml:Description> <command:parameterValue required="true">TimeSpan?</command:parameterValue> <dev:type> <maml:name>TimeSpan?</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="4"> <maml:name>ScheduleFrequencyType</maml:name> <maml:Description> <maml:para> Describes the frequency with which to run the time based backup schedule. . Possible values include: 'Invalid', 'Daily', 'Weekly' </maml:para> </maml:Description> <command:parameterValue required="true">BackupScheduleFrequencyType?</command:parameterValue> <dev:type> <maml:name>BackupScheduleFrequencyType?</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="5"> <maml:name>RunTimes</maml:name> <maml:Description> <maml:para> Represents the list of exact time during the day in ISO8601 format. Like '19:00:00' will represent '7PM' during the day. Date specified along with time will be ignored. </maml:para> </maml:Description> <command:parameterValue required="true">IEnumerable<DateTime?></command:parameterValue> <dev:type> <maml:name>IEnumerable<DateTime?></maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="6"> <maml:name>ConnectionString</maml:name> <maml:Description> <maml:para> The connection string to connect to the Azure blob store. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="7"> <maml:name>ContainerName</maml:name> <maml:Description> <maml:para> The name of the container in the blob store to store and enumerate backups from. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="8"> <maml:name>Path</maml:name> <maml:Description> <maml:para> UNC path of the file share where to store or enumerate backups from. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="9"> <maml:name>RetentionDuration</maml:name> <maml:Description> <maml:para> It is the minimum duration for which a backup created, will remain stored in the storage and might get deleted after that span of time. It should be specified in ISO8601 format. </maml:para> </maml:Description> <command:parameterValue required="true">TimeSpan?</command:parameterValue> <dev:type> <maml:name>TimeSpan?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>RunDays</maml:name> <maml:Description> <maml:para> List of days of a week when to trigger the periodic backup. This is valid only when the backup schedule frequency type is weekly. </maml:para> </maml:Description> <command:parameterValue required="false">IEnumerable<DayOfWeek?></command:parameterValue> <dev:type> <maml:name>IEnumerable<DayOfWeek?></maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>FriendlyName</maml:name> <maml:Description> <maml:para> Friendly name for this backup storage. </maml:para> </maml:Description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>PrimaryUserName</maml:name> <maml:Description> <maml:para> Primary user name to access the file share. </maml:para> </maml:Description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>PrimaryPassword</maml:name> <maml:Description> <maml:para> Primary password to access the share location. </maml:para> </maml:Description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>SecondaryUserName</maml:name> <maml:Description> <maml:para> Secondary user name to access the file share. </maml:para> </maml:Description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>SecondaryPassword</maml:name> <maml:Description> <maml:para> Secondary password to access the share location </maml:para> </maml:Description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>MinimumNumberOfBackups</maml:name> <maml:Description> <maml:para> It is the minimum number of backups to be retained at any point of time. If specified with a non zero value, backups will not be deleted even if the backups have gone past retention duration and have number of backups less than or equal to it. </maml:para> </maml:Description> <command:parameterValue required="false">int?</command:parameterValue> <dev:type> <maml:name>int?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-SFBackupPolicy</command:name> <command:verb>Remove</command:verb> <command:noun>BackupPolicy</command:noun> <maml:description> <maml:para>Deletes the backup policy.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Deletes an existing backup policy. A backup policy must be created before it can be deleted. A currently active backup policy, associated with any Service Fabric application, service or partition, cannot be deleted without first deleting the mapping. </maml:para> </maml:description> <command:parameters> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="0"> <maml:name>BackupPolicyName</maml:name> <maml:Description> <maml:para> The name of the backup policy. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-SFBackupPolicy</command:name> <command:verb>Get</command:verb> <command:noun>BackupPolicy</command:noun> <maml:description> <maml:para>Gets all the backup policies configured.</maml:para> </maml:description> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-SFBackupPolicy</maml:name> <command:parameter required="true"> <maml:name>BackupPolicyName</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>ServerTimeout</maml:name> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-SFBackupPolicy</maml:name> <command:parameter required="false"> <maml:name>MaxResults</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>ServerTimeout</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <maml:description> <maml:para>Get a list of all the backup policies configured. </maml:para> </maml:description> <command:parameters> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="0"> <maml:name>BackupPolicyName</maml:name> <maml:Description> <maml:para> The name of the backup policy. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>MaxResults</maml:name> <maml:Description> <maml:para> The maximum number of results to be returned as part of the paged queries. This parameter defines the upper bound on the number of results returned. The results returned can be less than the specified maximum results if they do not fit in the message as per the max message size restrictions defined in the configuration. If this parameter is zero or not specified, the paged query includes as many results as possible that fit in the return message. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-SFAllEntitiesBackedUpByPolicy</command:name> <command:verb>Get</command:verb> <command:noun>AllEntitiesBackedUpByPolicy</command:noun> <maml:description> <maml:para>Gets the list of backup entities that are associated with this policy.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Returns a list of Service Fabric application, service or partition which are associated with this backup policy. </maml:para> </maml:description> <command:parameters> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="0"> <maml:name>BackupPolicyName</maml:name> <maml:Description> <maml:para> The name of the backup policy. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>MaxResults</maml:name> <maml:Description> <maml:para> The maximum number of results to be returned as part of the paged queries. This parameter defines the upper bound on the number of results returned. The results returned can be less than the specified maximum results if they do not fit in the message as per the max message size restrictions defined in the configuration. If this parameter is zero or not specified, the paged query includes as many results as possible that fit in the return message. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Update-SFBackupPolicy</command:name> <command:verb>Update</command:verb> <command:noun>BackupPolicy</command:noun> <maml:description> <maml:para>Updates the backup policy.</maml:para> </maml:description> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Update-SFBackupPolicy</maml:name> <command:parameter required="true"> <maml:name>Interval</maml:name> </command:parameter> <command:parameter required="true"> <maml:name>ConnectionString</maml:name> </command:parameter> <command:parameter required="true"> <maml:name>ContainerName</maml:name> </command:parameter> <command:parameter required="true"> <maml:name>RetentionDuration</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>MinimumNumberOfBackups</maml:name> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Update-SFBackupPolicy</maml:name> <command:parameter required="true"> <maml:name>Interval</maml:name> </command:parameter> <command:parameter required="true"> <maml:name>Path</maml:name> </command:parameter> <command:parameter required="true"> <maml:name>RetentionDuration</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>PrimaryUserName</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>PrimaryPassword</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>SecondaryUserName</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>SecondaryPassword</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>MinimumNumberOfBackups</maml:name> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Update-SFBackupPolicy</maml:name> <command:parameter required="true"> <maml:name>ScheduleFrequencyType</maml:name> </command:parameter> <command:parameter required="true"> <maml:name>RunTimes</maml:name> </command:parameter> <command:parameter required="true"> <maml:name>ConnectionString</maml:name> </command:parameter> <command:parameter required="true"> <maml:name>ContainerName</maml:name> </command:parameter> <command:parameter required="true"> <maml:name>RetentionDuration</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>RunDays</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>MinimumNumberOfBackups</maml:name> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Update-SFBackupPolicy</maml:name> <command:parameter required="true"> <maml:name>ScheduleFrequencyType</maml:name> </command:parameter> <command:parameter required="true"> <maml:name>RunTimes</maml:name> </command:parameter> <command:parameter required="true"> <maml:name>Path</maml:name> </command:parameter> <command:parameter required="true"> <maml:name>RetentionDuration</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>RunDays</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>PrimaryUserName</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>PrimaryPassword</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>SecondaryUserName</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>SecondaryPassword</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>MinimumNumberOfBackups</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <maml:description> <maml:para>Updates the backup policy identified by {backupPolicyName} </maml:para> </maml:description> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Name</maml:name> <maml:Description> <maml:para> The unique name identifying this backup policy. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>AutoRestoreOnDataLoss</maml:name> <maml:Description> <maml:para> Specifies whether to trigger restore automatically using the latest available backup in case the partition experiences a data loss event. </maml:para> </maml:Description> <command:parameterValue required="true">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>MaxIncrementalBackups</maml:name> <maml:Description> <maml:para> Defines the maximum number of incremental backups to be taken between two full backups. This is just the upper limit. A full backup may be taken before specified number of incremental backups are completed in one of the following conditions - The replica has never taken a full backup since it has become primary, - Some of the log records since the last backup has been truncated, or - Replica passed the MaxAccumulatedBackupLogSizeInMB limit. </maml:para> </maml:Description> <command:parameterValue required="true">int?</command:parameterValue> <dev:type> <maml:name>int?</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="3"> <maml:name>Interval</maml:name> <maml:Description> <maml:para> Defines the interval with which backups are periodically taken. It should be specified in ISO8601 format. Timespan in seconds is not supported and will be ignored while creating the policy. </maml:para> </maml:Description> <command:parameterValue required="true">TimeSpan?</command:parameterValue> <dev:type> <maml:name>TimeSpan?</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="4"> <maml:name>ScheduleFrequencyType</maml:name> <maml:Description> <maml:para> Describes the frequency with which to run the time based backup schedule. . Possible values include: 'Invalid', 'Daily', 'Weekly' </maml:para> </maml:Description> <command:parameterValue required="true">BackupScheduleFrequencyType?</command:parameterValue> <dev:type> <maml:name>BackupScheduleFrequencyType?</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="5"> <maml:name>RunTimes</maml:name> <maml:Description> <maml:para> Represents the list of exact time during the day in ISO8601 format. Like '19:00:00' will represent '7PM' during the day. Date specified along with time will be ignored. </maml:para> </maml:Description> <command:parameterValue required="true">IEnumerable<DateTime?></command:parameterValue> <dev:type> <maml:name>IEnumerable<DateTime?></maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="6"> <maml:name>ConnectionString</maml:name> <maml:Description> <maml:para> The connection string to connect to the Azure blob store. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="7"> <maml:name>ContainerName</maml:name> <maml:Description> <maml:para> The name of the container in the blob store to store and enumerate backups from. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="8"> <maml:name>Path</maml:name> <maml:Description> <maml:para> UNC path of the file share where to store or enumerate backups from. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="9"> <maml:name>RetentionDuration</maml:name> <maml:Description> <maml:para> It is the minimum duration for which a backup created, will remain stored in the storage and might get deleted after that span of time. It should be specified in ISO8601 format. </maml:para> </maml:Description> <command:parameterValue required="true">TimeSpan?</command:parameterValue> <dev:type> <maml:name>TimeSpan?</maml:name> </dev:type> </command:parameter> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="10"> <maml:name>BackupPolicyName</maml:name> <maml:Description> <maml:para> The name of the backup policy. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>RunDays</maml:name> <maml:Description> <maml:para> List of days of a week when to trigger the periodic backup. This is valid only when the backup schedule frequency type is weekly. </maml:para> </maml:Description> <command:parameterValue required="false">IEnumerable<DayOfWeek?></command:parameterValue> <dev:type> <maml:name>IEnumerable<DayOfWeek?></maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>FriendlyName</maml:name> <maml:Description> <maml:para> Friendly name for this backup storage. </maml:para> </maml:Description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>PrimaryUserName</maml:name> <maml:Description> <maml:para> Primary user name to access the file share. </maml:para> </maml:Description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>PrimaryPassword</maml:name> <maml:Description> <maml:para> Primary password to access the share location. </maml:para> </maml:Description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>SecondaryUserName</maml:name> <maml:Description> <maml:para> Secondary user name to access the file share. </maml:para> </maml:Description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="16"> <maml:name>SecondaryPassword</maml:name> <maml:Description> <maml:para> Secondary password to access the share location </maml:para> </maml:Description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="17"> <maml:name>MinimumNumberOfBackups</maml:name> <maml:Description> <maml:para> It is the minimum number of backups to be retained at any point of time. If specified with a non zero value, backups will not be deleted even if the backups have gone past retention duration and have number of backups less than or equal to it. </maml:para> </maml:Description> <command:parameterValue required="false">int?</command:parameterValue> <dev:type> <maml:name>int?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="18"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Enable-SFApplicationBackup</command:name> <command:verb>Enable</command:verb> <command:noun>ApplicationBackup</command:noun> <maml:description> <maml:para>Enables periodic backup of stateful partitions under this Service Fabric application.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Enables periodic backup of stateful partitions which are part of this Service Fabric application. Each partition is backed up individually as per the specified backup policy description. Note only C# based Reliable Actor and Reliable Stateful services are currently supported for periodic backup. </maml:para> </maml:description> <command:parameters> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="0"> <maml:name>ApplicationId</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>BackupPolicyName</maml:name> <maml:Description> <maml:para> Name of the backup policy to be used for enabling periodic backups. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Disable-SFApplicationBackup</command:name> <command:verb>Disable</command:verb> <command:noun>ApplicationBackup</command:noun> <maml:description> <maml:para>Disables periodic backup of Service Fabric application.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Disables periodic backup of Service Fabric application which was previously enabled. </maml:para> </maml:description> <command:parameters> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="0"> <maml:name>ApplicationId</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>CleanBackup</maml:name> <maml:Description> <maml:para> Boolean flag to delete backups. It can be set to true for deleting all the backups which were created for the backup entity that is getting disabled for backup. </maml:para> </maml:Description> <command:parameterValue required="true">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-SFApplicationBackupConfigurationInfo</command:name> <command:verb>Get</command:verb> <command:noun>ApplicationBackupConfigurationInfo</command:noun> <maml:description> <maml:para>Gets the Service Fabric application backup configuration information.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Gets the Service Fabric backup configuration information for the application and the services and partitions under this application. </maml:para> </maml:description> <command:parameters> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="0"> <maml:name>ApplicationId</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>MaxResults</maml:name> <maml:Description> <maml:para> The maximum number of results to be returned as part of the paged queries. This parameter defines the upper bound on the number of results returned. The results returned can be less than the specified maximum results if they do not fit in the message as per the max message size restrictions defined in the configuration. If this parameter is zero or not specified, the paged query includes as many results as possible that fit in the return message. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-SFApplicationBackupList</command:name> <command:verb>Get</command:verb> <command:noun>ApplicationBackupList</command:noun> <maml:description> <maml:para>Gets the list of backups available for every partition in this application.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Returns a list of backups available for every partition in this Service Fabric application. The server enumerates all the backups available at the backup location configured in the backup policy. It also allows filtering of the result based on start and end datetime or just fetching the latest available backup for every partition. </maml:para> </maml:description> <command:parameters> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="0"> <maml:name>ApplicationId</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Latest</maml:name> <maml:Description> <maml:para> Specifies whether to get only the most recent backup available for a partition for the specified time range. </maml:para> </maml:Description> <command:parameterValue required="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>StartDateTimeFilter</maml:name> <maml:Description> <maml:para> Specify the start date time from which to enumerate backups, in datetime format. The date time must be specified in ISO8601 format. This is an optional parameter. If not specified, all backups from the beginning are enumerated. </maml:para> </maml:Description> <command:parameterValue required="false">DateTime?</command:parameterValue> <dev:type> <maml:name>DateTime?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>EndDateTimeFilter</maml:name> <maml:Description> <maml:para> Specify the end date time till which to enumerate backups, in datetime format. The date time must be specified in ISO8601 format. This is an optional parameter. If not specified, enumeration is done till the most recent backup. </maml:para> </maml:Description> <command:parameterValue required="false">DateTime?</command:parameterValue> <dev:type> <maml:name>DateTime?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>MaxResults</maml:name> <maml:Description> <maml:para> The maximum number of results to be returned as part of the paged queries. This parameter defines the upper bound on the number of results returned. The results returned can be less than the specified maximum results if they do not fit in the message as per the max message size restrictions defined in the configuration. If this parameter is zero or not specified, the paged query includes as many results as possible that fit in the return message. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Suspend-SFApplicationBackup</command:name> <command:verb>Suspend</command:verb> <command:noun>ApplicationBackup</command:noun> <maml:description> <maml:para>Suspends periodic backup for the specified Service Fabric application.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>The application which is configured to take periodic backups, is suspended for taking further backups till it is resumed again. This operation applies to the entire application's hierarchy. It means all the services and partitions under this application are now suspended for backup.</maml:para> </maml:description> <command:parameters> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="0"> <maml:name>ApplicationId</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Resume-SFApplicationBackup</command:name> <command:verb>Resume</command:verb> <command:noun>ApplicationBackup</command:noun> <maml:description> <maml:para>Resumes periodic backup of a Service Fabric application which was previously suspended.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>The previously suspended Service Fabric application resumes taking periodic backup as per the backup policy currently configured for the same.</maml:para> </maml:description> <command:parameters> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="0"> <maml:name>ApplicationId</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Enable-SFServiceBackup</command:name> <command:verb>Enable</command:verb> <command:noun>ServiceBackup</command:noun> <maml:description> <maml:para>Enables periodic backup of stateful partitions under this Service Fabric service.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Enables periodic backup of stateful partitions which are part of this Service Fabric service. Each partition is backed up individually as per the specified backup policy description. In case the application, which the service is part of, is already enabled for backup then this operation would override the policy being used to take the periodic backup for this service and its partitions (unless explicitly overridden at the partition level). Note only C# based Reliable Actor and Reliable Stateful services are currently supported for periodic backup. </maml:para> </maml:description> <command:parameters> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="0"> <maml:name>ServiceId</maml:name> <maml:Description> <maml:para> The identity of the service. This ID is typically the full name of the service without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the service name is "fabric:/myapp/app1/svc1", the service identity would be "myapp~app1~svc1" in 6.0+ and "myapp/app1/svc1" in previous versions. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>BackupPolicyName</maml:name> <maml:Description> <maml:para> Name of the backup policy to be used for enabling periodic backups. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Disable-SFServiceBackup</command:name> <command:verb>Disable</command:verb> <command:noun>ServiceBackup</command:noun> <maml:description> <maml:para>Disables periodic backup of Service Fabric service which was previously enabled.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Disables periodic backup of Service Fabric service which was previously enabled. Backup must be explicitly enabled before it can be disabled. In case the backup is enabled for the Service Fabric application, which this service is part of, this service would continue to be periodically backed up as per the policy mapped at the application level. </maml:para> </maml:description> <command:parameters> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="0"> <maml:name>ServiceId</maml:name> <maml:Description> <maml:para> The identity of the service. This ID is typically the full name of the service without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the service name is "fabric:/myapp/app1/svc1", the service identity would be "myapp~app1~svc1" in 6.0+ and "myapp/app1/svc1" in previous versions. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>CleanBackup</maml:name> <maml:Description> <maml:para> Boolean flag to delete backups. It can be set to true for deleting all the backups which were created for the backup entity that is getting disabled for backup. </maml:para> </maml:Description> <command:parameterValue required="true">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-SFServiceBackupConfigurationInfo</command:name> <command:verb>Get</command:verb> <command:noun>ServiceBackupConfigurationInfo</command:noun> <maml:description> <maml:para>Gets the Service Fabric service backup configuration information.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Gets the Service Fabric backup configuration information for the service and the partitions under this service. </maml:para> </maml:description> <command:parameters> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="0"> <maml:name>ServiceId</maml:name> <maml:Description> <maml:para> The identity of the service. This ID is typically the full name of the service without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the service name is "fabric:/myapp/app1/svc1", the service identity would be "myapp~app1~svc1" in 6.0+ and "myapp/app1/svc1" in previous versions. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>MaxResults</maml:name> <maml:Description> <maml:para> The maximum number of results to be returned as part of the paged queries. This parameter defines the upper bound on the number of results returned. The results returned can be less than the specified maximum results if they do not fit in the message as per the max message size restrictions defined in the configuration. If this parameter is zero or not specified, the paged query includes as many results as possible that fit in the return message. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-SFServiceBackupList</command:name> <command:verb>Get</command:verb> <command:noun>ServiceBackupList</command:noun> <maml:description> <maml:para>Gets the list of backups available for every partition in this service.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Returns a list of backups available for every partition in this Service Fabric service. The server enumerates all the backups available in the backup store configured in the backup policy. It also allows filtering of the result based on start and end datetime or just fetching the latest available backup for every partition. </maml:para> </maml:description> <command:parameters> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="0"> <maml:name>ServiceId</maml:name> <maml:Description> <maml:para> The identity of the service. This ID is typically the full name of the service without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the service name is "fabric:/myapp/app1/svc1", the service identity would be "myapp~app1~svc1" in 6.0+ and "myapp/app1/svc1" in previous versions. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Latest</maml:name> <maml:Description> <maml:para> Specifies whether to get only the most recent backup available for a partition for the specified time range. </maml:para> </maml:Description> <command:parameterValue required="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>StartDateTimeFilter</maml:name> <maml:Description> <maml:para> Specify the start date time from which to enumerate backups, in datetime format. The date time must be specified in ISO8601 format. This is an optional parameter. If not specified, all backups from the beginning are enumerated. </maml:para> </maml:Description> <command:parameterValue required="false">DateTime?</command:parameterValue> <dev:type> <maml:name>DateTime?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>EndDateTimeFilter</maml:name> <maml:Description> <maml:para> Specify the end date time till which to enumerate backups, in datetime format. The date time must be specified in ISO8601 format. This is an optional parameter. If not specified, enumeration is done till the most recent backup. </maml:para> </maml:Description> <command:parameterValue required="false">DateTime?</command:parameterValue> <dev:type> <maml:name>DateTime?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>MaxResults</maml:name> <maml:Description> <maml:para> The maximum number of results to be returned as part of the paged queries. This parameter defines the upper bound on the number of results returned. The results returned can be less than the specified maximum results if they do not fit in the message as per the max message size restrictions defined in the configuration. If this parameter is zero or not specified, the paged query includes as many results as possible that fit in the return message. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Suspend-SFServiceBackup</command:name> <command:verb>Suspend</command:verb> <command:noun>ServiceBackup</command:noun> <maml:description> <maml:para>Suspends periodic backup for the specified Service Fabric service.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>The service which is configured to take periodic backups, is suspended for taking further backups till it is resumed again. This operation applies to the entire service's hierarchy. It means all the partitions under this service are now suspended for backup.</maml:para> </maml:description> <command:parameters> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="0"> <maml:name>ServiceId</maml:name> <maml:Description> <maml:para> The identity of the service. This ID is typically the full name of the service without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the service name is "fabric:/myapp/app1/svc1", the service identity would be "myapp~app1~svc1" in 6.0+ and "myapp/app1/svc1" in previous versions. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Resume-SFServiceBackup</command:name> <command:verb>Resume</command:verb> <command:noun>ServiceBackup</command:noun> <maml:description> <maml:para>Resumes periodic backup of a Service Fabric service which was previously suspended.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>The previously suspended Service Fabric service resumes taking periodic backup as per the backup policy currently configured for the same.</maml:para> </maml:description> <command:parameters> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="0"> <maml:name>ServiceId</maml:name> <maml:Description> <maml:para> The identity of the service. This ID is typically the full name of the service without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the service name is "fabric:/myapp/app1/svc1", the service identity would be "myapp~app1~svc1" in 6.0+ and "myapp/app1/svc1" in previous versions. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Enable-SFPartitionBackup</command:name> <command:verb>Enable</command:verb> <command:noun>PartitionBackup</command:noun> <maml:description> <maml:para>Enables periodic backup of the stateful persisted partition.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Enables periodic backup of stateful persisted partition. Each partition is backed up as per the specified backup policy description. In case the application or service, which is partition is part of, is already enabled for backup then this operation would override the policy being used to take the periodic backup of this partition. Note only C# based Reliable Actor and Reliable Stateful services are currently supported for periodic backup. </maml:para> </maml:description> <command:parameters> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="0"> <maml:name>PartitionId</maml:name> <maml:Description> <maml:para> The identity of the partition. </maml:para> </maml:Description> <command:parameterValue required="true">PartitionId</command:parameterValue> <dev:type> <maml:name>PartitionId</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>BackupPolicyName</maml:name> <maml:Description> <maml:para> Name of the backup policy to be used for enabling periodic backups. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Disable-SFPartitionBackup</command:name> <command:verb>Disable</command:verb> <command:noun>PartitionBackup</command:noun> <maml:description> <maml:para>Disables periodic backup of Service Fabric partition which was previously enabled.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Disables periodic backup of partition which was previously enabled. Backup must be explicitly enabled before it can be disabled. In case the backup is enabled for the Service Fabric application or service, which this partition is part of, this partition would continue to be periodically backed up as per the policy mapped at the higher level entity. </maml:para> </maml:description> <command:parameters> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="0"> <maml:name>PartitionId</maml:name> <maml:Description> <maml:para> The identity of the partition. </maml:para> </maml:Description> <command:parameterValue required="true">PartitionId</command:parameterValue> <dev:type> <maml:name>PartitionId</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>CleanBackup</maml:name> <maml:Description> <maml:para> Boolean flag to delete backups. It can be set to true for deleting all the backups which were created for the backup entity that is getting disabled for backup. </maml:para> </maml:Description> <command:parameterValue required="true">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-SFPartitionBackupConfigurationInfo</command:name> <command:verb>Get</command:verb> <command:noun>PartitionBackupConfigurationInfo</command:noun> <maml:description> <maml:para>Gets the partition backup configuration information</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Gets the Service Fabric Backup configuration information for the specified partition. </maml:para> </maml:description> <command:parameters> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="0"> <maml:name>PartitionId</maml:name> <maml:Description> <maml:para> The identity of the partition. </maml:para> </maml:Description> <command:parameterValue required="true">PartitionId</command:parameterValue> <dev:type> <maml:name>PartitionId</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-SFPartitionBackupList</command:name> <command:verb>Get</command:verb> <command:noun>PartitionBackupList</command:noun> <maml:description> <maml:para>Gets the list of backups available for the specified partition.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Returns a list of backups available for the specified partition. The server enumerates all the backups available in the backup store configured in the backup policy. It also allows filtering of the result based on start and end datetime or just fetching the latest available backup for the partition. </maml:para> </maml:description> <command:parameters> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="0"> <maml:name>PartitionId</maml:name> <maml:Description> <maml:para> The identity of the partition. </maml:para> </maml:Description> <command:parameterValue required="true">PartitionId</command:parameterValue> <dev:type> <maml:name>PartitionId</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>Latest</maml:name> <maml:Description> <maml:para> Specifies whether to get only the most recent backup available for a partition for the specified time range. </maml:para> </maml:Description> <command:parameterValue required="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>StartDateTimeFilter</maml:name> <maml:Description> <maml:para> Specify the start date time from which to enumerate backups, in datetime format. The date time must be specified in ISO8601 format. This is an optional parameter. If not specified, all backups from the beginning are enumerated. </maml:para> </maml:Description> <command:parameterValue required="false">DateTime?</command:parameterValue> <dev:type> <maml:name>DateTime?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>EndDateTimeFilter</maml:name> <maml:Description> <maml:para> Specify the end date time till which to enumerate backups, in datetime format. The date time must be specified in ISO8601 format. This is an optional parameter. If not specified, enumeration is done till the most recent backup. </maml:para> </maml:Description> <command:parameterValue required="false">DateTime?</command:parameterValue> <dev:type> <maml:name>DateTime?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Suspend-SFPartitionBackup</command:name> <command:verb>Suspend</command:verb> <command:noun>PartitionBackup</command:noun> <maml:description> <maml:para>Suspends periodic backup for the specified partition.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>The partition which is configured to take periodic backups, is suspended for taking further backups till it is resumed again.</maml:para> </maml:description> <command:parameters> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="0"> <maml:name>PartitionId</maml:name> <maml:Description> <maml:para> The identity of the partition. </maml:para> </maml:Description> <command:parameterValue required="true">PartitionId</command:parameterValue> <dev:type> <maml:name>PartitionId</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Resume-SFPartitionBackup</command:name> <command:verb>Resume</command:verb> <command:noun>PartitionBackup</command:noun> <maml:description> <maml:para>Resumes periodic backup of partition which was previously suspended.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>The previously suspended partition resumes taking periodic backup as per the backup policy currently configured for the same.</maml:para> </maml:description> <command:parameters> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="0"> <maml:name>PartitionId</maml:name> <maml:Description> <maml:para> The identity of the partition. </maml:para> </maml:Description> <command:parameterValue required="true">PartitionId</command:parameterValue> <dev:type> <maml:name>PartitionId</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Backup-SFPartition</command:name> <command:verb>Backup</command:verb> <command:noun>Partition</command:noun> <maml:description> <maml:para>Triggers backup of the partition's state.</maml:para> </maml:description> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Backup-SFPartition</maml:name> <command:parameter required="true"> <maml:name>ConnectionString</maml:name> </command:parameter> <command:parameter required="true"> <maml:name>ContainerName</maml:name> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Backup-SFPartition</maml:name> <command:parameter required="true"> <maml:name>Path</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>PrimaryUserName</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>PrimaryPassword</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>SecondaryUserName</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>SecondaryPassword</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <maml:description> <maml:para>Creates a backup of the stateful persisted partition's state. In case the partition is already being periodically backed up, then by default the new backup is created at the same backup storage. One can also override the same by specifying the backup storage details as part of the request body. Once the backup is initiated, its progress can be tracked using the GetBackupProgress operation. In case, the operation times out, specify a greater backup timeout value in the query parameter. </maml:para> </maml:description> <command:parameters> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="0"> <maml:name>PartitionId</maml:name> <maml:Description> <maml:para> The identity of the partition. </maml:para> </maml:Description> <command:parameterValue required="true">PartitionId</command:parameterValue> <dev:type> <maml:name>PartitionId</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>ConnectionString</maml:name> <maml:Description> <maml:para> The connection string to connect to the Azure blob store. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>ContainerName</maml:name> <maml:Description> <maml:para> The name of the container in the blob store to store and enumerate backups from. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="3"> <maml:name>Path</maml:name> <maml:Description> <maml:para> UNC path of the file share where to store or enumerate backups from. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>FriendlyName</maml:name> <maml:Description> <maml:para> Friendly name for this backup storage. </maml:para> </maml:Description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>PrimaryUserName</maml:name> <maml:Description> <maml:para> Primary user name to access the file share. </maml:para> </maml:Description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>PrimaryPassword</maml:name> <maml:Description> <maml:para> Primary password to access the share location. </maml:para> </maml:Description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>SecondaryUserName</maml:name> <maml:Description> <maml:para> Secondary user name to access the file share. </maml:para> </maml:Description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>SecondaryPassword</maml:name> <maml:Description> <maml:para> Secondary password to access the share location </maml:para> </maml:Description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>BackupTimeout</maml:name> <maml:Description> <maml:para> Specifies the maximum amount of time, in minutes, to wait for the backup operation to complete. Post that, the operation completes with timeout error. However, in certain corner cases it could be that though the operation returns back timeout, the backup actually goes through. In case of timeout error, its recommended to invoke this operation again with a greater timeout value. The default value for the same is 10 minutes. </maml:para> </maml:Description> <command:parameterValue required="false">int?</command:parameterValue> <dev:type> <maml:name>int?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-SFPartitionBackupProgress</command:name> <command:verb>Get</command:verb> <command:noun>PartitionBackupProgress</command:noun> <maml:description> <maml:para>Gets details for the latest backup triggered for this partition.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Returns information about the state of the latest backup along with details or failure reason in case of completion. </maml:para> </maml:description> <command:parameters> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="0"> <maml:name>PartitionId</maml:name> <maml:Description> <maml:para> The identity of the partition. </maml:para> </maml:Description> <command:parameterValue required="true">PartitionId</command:parameterValue> <dev:type> <maml:name>PartitionId</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Restore-SFPartition</command:name> <command:verb>Restore</command:verb> <command:noun>Partition</command:noun> <maml:description> <maml:para>Triggers restore of the state of the partition using the specified restore partition description.</maml:para> </maml:description> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Restore-SFPartition</maml:name> <command:parameter required="true"> <maml:name>ConnectionString</maml:name> </command:parameter> <command:parameter required="true"> <maml:name>ContainerName</maml:name> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Restore-SFPartition</maml:name> <command:parameter required="true"> <maml:name>Path</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>PrimaryUserName</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>PrimaryPassword</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>SecondaryUserName</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>SecondaryPassword</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <maml:description> <maml:para>Restores the state of a of the stateful persisted partition using the specified backup point. In case the partition is already being periodically backed up, then by default the backup point is looked for in the storage specified in backup policy. One can also override the same by specifying the backup storage details as part of the restore partition description in body. Once the restore is initiated, its progress can be tracked using the GetRestoreProgress operation. In case, the operation times out, specify a greater restore timeout value in the query parameter. </maml:para> </maml:description> <command:parameters> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="0"> <maml:name>PartitionId</maml:name> <maml:Description> <maml:para> The identity of the partition. </maml:para> </maml:Description> <command:parameterValue required="true">PartitionId</command:parameterValue> <dev:type> <maml:name>PartitionId</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>BackupId</maml:name> <maml:Description> <maml:para> Unique backup ID. </maml:para> </maml:Description> <command:parameterValue required="true">Guid?</command:parameterValue> <dev:type> <maml:name>Guid?</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>BackupLocation</maml:name> <maml:Description> <maml:para> Location of the backup relative to the backup storage specified/ configured. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="3"> <maml:name>ConnectionString</maml:name> <maml:Description> <maml:para> The connection string to connect to the Azure blob store. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="4"> <maml:name>ContainerName</maml:name> <maml:Description> <maml:para> The name of the container in the blob store to store and enumerate backups from. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="5"> <maml:name>Path</maml:name> <maml:Description> <maml:para> UNC path of the file share where to store or enumerate backups from. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>FriendlyName</maml:name> <maml:Description> <maml:para> Friendly name for this backup storage. </maml:para> </maml:Description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>PrimaryUserName</maml:name> <maml:Description> <maml:para> Primary user name to access the file share. </maml:para> </maml:Description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>PrimaryPassword</maml:name> <maml:Description> <maml:para> Primary password to access the share location. </maml:para> </maml:Description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>SecondaryUserName</maml:name> <maml:Description> <maml:para> Secondary user name to access the file share. </maml:para> </maml:Description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>SecondaryPassword</maml:name> <maml:Description> <maml:para> Secondary password to access the share location </maml:para> </maml:Description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>RestoreTimeout</maml:name> <maml:Description> <maml:para> Specifies the maximum amount of time to wait, in minutes, for the restore operation to complete. Post that, the operation returns back with timeout error. However, in certain corner cases it could be that the restore operation goes through even though it completes with timeout. In case of timeout error, its recommended to invoke this operation again with a greater timeout value. the default value for the same is 10 minutes. </maml:para> </maml:Description> <command:parameterValue required="false">int?</command:parameterValue> <dev:type> <maml:name>int?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-SFPartitionRestoreProgress</command:name> <command:verb>Get</command:verb> <command:noun>PartitionRestoreProgress</command:noun> <maml:description> <maml:para>Gets details for the latest restore operation triggered for this partition.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Returns information about the state of the latest restore operation along with details or failure reason in case of completion. </maml:para> </maml:description> <command:parameters> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="0"> <maml:name>PartitionId</maml:name> <maml:Description> <maml:para> The identity of the partition. </maml:para> </maml:Description> <command:parameterValue required="true">PartitionId</command:parameterValue> <dev:type> <maml:name>PartitionId</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-SFBackupsFromBackupLocation</command:name> <command:verb>Get</command:verb> <command:noun>BackupsFromBackupLocation</command:noun> <maml:description> <maml:para>Gets the list of backups available for the specified backed up entity at the specified backup location.</maml:para> </maml:description> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-SFBackupsFromBackupLocation</maml:name> <command:parameter required="true"> <maml:name>ConnectionString</maml:name> </command:parameter> <command:parameter required="true"> <maml:name>ContainerName</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>ApplicationName</maml:name> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-SFBackupsFromBackupLocation</maml:name> <command:parameter required="true"> <maml:name>ConnectionString</maml:name> </command:parameter> <command:parameter required="true"> <maml:name>ContainerName</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>ServiceName</maml:name> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-SFBackupsFromBackupLocation</maml:name> <command:parameter required="true"> <maml:name>ConnectionString</maml:name> </command:parameter> <command:parameter required="true"> <maml:name>ContainerName</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>ServiceName</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>PartitionId</maml:name> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-SFBackupsFromBackupLocation</maml:name> <command:parameter required="true"> <maml:name>Path</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>PrimaryUserName</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>PrimaryPassword</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>SecondaryUserName</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>SecondaryPassword</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>ApplicationName</maml:name> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-SFBackupsFromBackupLocation</maml:name> <command:parameter required="true"> <maml:name>Path</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>PrimaryUserName</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>PrimaryPassword</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>SecondaryUserName</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>SecondaryPassword</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>ServiceName</maml:name> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-SFBackupsFromBackupLocation</maml:name> <command:parameter required="true"> <maml:name>Path</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>PrimaryUserName</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>PrimaryPassword</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>SecondaryUserName</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>SecondaryPassword</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>ServiceName</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>PartitionId</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <maml:description> <maml:para>Gets the list of backups available for the specified backed up entity (Application, Service or Partition) at the specified backup location (FileShare or Azure Blob Storage). </maml:para> </maml:description> <command:parameters> <command:parameter required="true" position="0"> <maml:name>ConnectionString</maml:name> <maml:Description> <maml:para> The connection string to connect to the Azure blob store. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>ContainerName</maml:name> <maml:Description> <maml:para> The name of the container in the blob store to store and enumerate backups from. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>Path</maml:name> <maml:Description> <maml:para> UNC path of the file share where to store or enumerate backups from. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>StartDateTimeFilter</maml:name> <maml:Description> <maml:para> Specifies the start date time in ISO8601 from which to enumerate backups. If not specified, backups are enumerated from the beginning. </maml:para> </maml:Description> <command:parameterValue required="false">DateTime?</command:parameterValue> <dev:type> <maml:name>DateTime?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>EndDateTimeFilter</maml:name> <maml:Description> <maml:para> Specifies the end date time in ISO8601 till which to enumerate backups. If not specified, backups are enumerated till the end. </maml:para> </maml:Description> <command:parameterValue required="false">DateTime?</command:parameterValue> <dev:type> <maml:name>DateTime?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>Latest</maml:name> <maml:Description> <maml:para> If specified as true, gets the most recent backup (within the specified time range) for every partition under the specified backup entity. </maml:para> </maml:Description> <command:parameterValue required="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>FriendlyName</maml:name> <maml:Description> <maml:para> Friendly name for this backup storage. </maml:para> </maml:Description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>PrimaryUserName</maml:name> <maml:Description> <maml:para> Primary user name to access the file share. </maml:para> </maml:Description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="8"> <maml:name>PrimaryPassword</maml:name> <maml:Description> <maml:para> Primary password to access the share location. </maml:para> </maml:Description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="9"> <maml:name>SecondaryUserName</maml:name> <maml:Description> <maml:para> Secondary user name to access the file share. </maml:para> </maml:Description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="10"> <maml:name>SecondaryPassword</maml:name> <maml:Description> <maml:para> Secondary password to access the share location </maml:para> </maml:Description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="11"> <maml:name>ApplicationName</maml:name> <maml:Description> <maml:para> The name of the application, including the 'fabric:' URI scheme. </maml:para> </maml:Description> <command:parameterValue required="false">ApplicationName</command:parameterValue> <dev:type> <maml:name>ApplicationName</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="12"> <maml:name>ServiceName</maml:name> <maml:Description> <maml:para> The full name of the service with 'fabric:' URI scheme. </maml:para> </maml:Description> <command:parameterValue required="false">ServiceName</command:parameterValue> <dev:type> <maml:name>ServiceName</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="13"> <maml:name>PartitionId</maml:name> <maml:Description> <maml:para> The partition ID identifying the partition. </maml:para> </maml:Description> <command:parameterValue required="false">PartitionId</command:parameterValue> <dev:type> <maml:name>PartitionId</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="14"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="15"> <maml:name>MaxResults</maml:name> <maml:Description> <maml:para> The maximum number of results to be returned as part of the paged queries. This parameter defines the upper bound on the number of results returned. The results returned can be less than the specified maximum results if they do not fit in the message as per the max message size restrictions defined in the configuration. If this parameter is zero or not specified, the paged query includes as many results as possible that fit in the return message. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-SFName</command:name> <command:verb>New</command:verb> <command:noun>Name</command:noun> <maml:description> <maml:para>Creates a Service Fabric name.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Creates the specified Service Fabric name.</maml:para> </maml:description> <command:parameters> <command:parameter required="true" position="0"> <maml:name>Name</maml:name> <maml:Description> <maml:para> The Service Fabric name, including the 'fabric:' URI scheme. </maml:para> </maml:Description> <command:parameterValue required="true">FabricName</command:parameterValue> <dev:type> <maml:name>FabricName</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-SFNameExistsInfo</command:name> <command:verb>Get</command:verb> <command:noun>NameExistsInfo</command:noun> <maml:description> <maml:para>Returns whether the Service Fabric name exists.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Returns whether the specified Service Fabric name exists.</maml:para> </maml:description> <command:parameters> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="0"> <maml:name>NameId</maml:name> <maml:Description> <maml:para> The Service Fabric name, without the 'fabric:' URI scheme. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-SFName</command:name> <command:verb>Remove</command:verb> <command:noun>Name</command:noun> <maml:description> <maml:para>Deletes a Service Fabric name.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Deletes the specified Service Fabric name. A name must be created before it can be deleted. Deleting a name with child properties will fail.</maml:para> </maml:description> <command:parameters> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="0"> <maml:name>NameId</maml:name> <maml:Description> <maml:para> The Service Fabric name, without the 'fabric:' URI scheme. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-SFSubNameInfoList</command:name> <command:verb>Get</command:verb> <command:noun>SubNameInfoList</command:noun> <maml:description> <maml:para>Enumerates all the Service Fabric names under a given name.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Enumerates all the Service Fabric names under a given name. If the subnames do not fit in a page, one page of results is returned as well as a continuation token, which can be used to get the next page. Querying a name that doesn't exist will fail.</maml:para> </maml:description> <command:parameters> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="0"> <maml:name>NameId</maml:name> <maml:Description> <maml:para> The Service Fabric name, without the 'fabric:' URI scheme. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Recursive</maml:name> <maml:Description> <maml:para> Allows specifying that the search performed should be recursive. </maml:para> </maml:Description> <command:parameterValue required="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-SFPropertyInfoList</command:name> <command:verb>Get</command:verb> <command:noun>PropertyInfoList</command:noun> <maml:description> <maml:para>Gets information on all Service Fabric properties under a given name.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>A Service Fabric name can have one or more named properties that store custom information. This operation gets the information about these properties in a paged list. The information includes name, value, and metadata about each of the properties.</maml:para> </maml:description> <command:parameters> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="0"> <maml:name>NameId</maml:name> <maml:Description> <maml:para> The Service Fabric name, without the 'fabric:' URI scheme. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>IncludeValues</maml:name> <maml:Description> <maml:para> Allows specifying whether to include the values of the properties returned. True if values should be returned with the metadata; False to return only property metadata. </maml:para> </maml:Description> <command:parameterValue required="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-SFPropertyInfo</command:name> <command:verb>Get</command:verb> <command:noun>PropertyInfo</command:noun> <maml:description> <maml:para>Gets the specified Service Fabric property.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Gets the specified Service Fabric property under a given name. This will always return both value and metadata.</maml:para> </maml:description> <command:parameters> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="0"> <maml:name>NameId</maml:name> <maml:Description> <maml:para> The Service Fabric name, without the 'fabric:' URI scheme. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="1"> <maml:name>PropertyName</maml:name> <maml:Description> <maml:para> Specifies the name of the property to get. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-SFProperty</command:name> <command:verb>Remove</command:verb> <command:noun>Property</command:noun> <maml:description> <maml:para>Deletes the specified Service Fabric property.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Deletes the specified Service Fabric property under a given name. A property must be created before it can be deleted.</maml:para> </maml:description> <command:parameters> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="0"> <maml:name>NameId</maml:name> <maml:Description> <maml:para> The Service Fabric name, without the 'fabric:' URI scheme. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="1"> <maml:name>PropertyName</maml:name> <maml:Description> <maml:para> Specifies the name of the property to get. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Submit-SFPropertyBatch</command:name> <command:verb>Submit</command:verb> <command:noun>PropertyBatch</command:noun> <maml:description> <maml:para>Submits a property batch.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Submits a batch of property operations. Either all or none of the operations will be committed.</maml:para> </maml:description> <command:parameters> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="0"> <maml:name>NameId</maml:name> <maml:Description> <maml:para> The Service Fabric name, without the 'fabric:' URI scheme. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>Operations</maml:name> <maml:Description> <maml:para> A list of the property batch operations to be executed. </maml:para> </maml:Description> <command:parameterValue required="false">IEnumerable<PropertyBatchOperation></command:parameterValue> <dev:type> <maml:name>IEnumerable<PropertyBatchOperation></maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-SFClusterEventList</command:name> <command:verb>Get</command:verb> <command:noun>ClusterEventList</command:noun> <maml:description> <maml:para>Gets all Cluster-related events.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>The response is list of ClusterEvent objects.</maml:para> </maml:description> <command:parameters> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="0"> <maml:name>StartTimeUtc</maml:name> <maml:Description> <maml:para> The start time of a lookup query in ISO UTC yyyy-MM-ddTHH:mm:ssZ. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="1"> <maml:name>EndTimeUtc</maml:name> <maml:Description> <maml:para> The end time of a lookup query in ISO UTC yyyy-MM-ddTHH:mm:ssZ. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>EventsTypesFilter</maml:name> <maml:Description> <maml:para> This is a comma separated string specifying the types of FabricEvents that should only be included in the response. </maml:para> </maml:Description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>ExcludeAnalysisEvents</maml:name> <maml:Description> <maml:para> This param disables the retrieval of AnalysisEvents if true is passed. </maml:para> </maml:Description> <command:parameterValue required="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SkipCorrelationLookup</maml:name> <maml:Description> <maml:para> This param disables the search of CorrelatedEvents information if true is passed. otherwise the CorrelationEvents get processed and HasCorrelatedEvents field in every FabricEvent gets populated. </maml:para> </maml:Description> <command:parameterValue required="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-SFContainersEventList</command:name> <command:verb>Get</command:verb> <command:noun>ContainersEventList</command:noun> <maml:description> <maml:para>Gets all Containers-related events.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>The response is list of ContainerInstanceEvent objects.</maml:para> </maml:description> <command:parameters> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="0"> <maml:name>StartTimeUtc</maml:name> <maml:Description> <maml:para> The start time of a lookup query in ISO UTC yyyy-MM-ddTHH:mm:ssZ. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="1"> <maml:name>EndTimeUtc</maml:name> <maml:Description> <maml:para> The end time of a lookup query in ISO UTC yyyy-MM-ddTHH:mm:ssZ. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="2"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>EventsTypesFilter</maml:name> <maml:Description> <maml:para> This is a comma separated string specifying the types of FabricEvents that should only be included in the response. </maml:para> </maml:Description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>ExcludeAnalysisEvents</maml:name> <maml:Description> <maml:para> This param disables the retrieval of AnalysisEvents if true is passed. </maml:para> </maml:Description> <command:parameterValue required="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>SkipCorrelationLookup</maml:name> <maml:Description> <maml:para> This param disables the search of CorrelatedEvents information if true is passed. otherwise the CorrelationEvents get processed and HasCorrelatedEvents field in every FabricEvent gets populated. </maml:para> </maml:Description> <command:parameterValue required="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-SFNodesEvent</command:name> <command:verb>Get</command:verb> <command:noun>NodesEvent</command:noun> <maml:description> <maml:para>Gets all Nodes-related Events.</maml:para> </maml:description> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-SFNodesEvent</maml:name> <command:parameter required="true"> <maml:name>StartTimeUtc</maml:name> </command:parameter> <command:parameter required="true"> <maml:name>EndTimeUtc</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>ServerTimeout</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>EventsTypesFilter</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>ExcludeAnalysisEvents</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>SkipCorrelationLookup</maml:name> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-SFNodesEvent</maml:name> <command:parameter required="true"> <maml:name>StartTimeUtc</maml:name> </command:parameter> <command:parameter required="true"> <maml:name>EndTimeUtc</maml:name> </command:parameter> <command:parameter required="true"> <maml:name>NodeName</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>ServerTimeout</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>EventsTypesFilter</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>ExcludeAnalysisEvents</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>SkipCorrelationLookup</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <maml:description> <maml:para>The response is list of NodeEvent objects.</maml:para> </maml:description> <command:parameters> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="0"> <maml:name>StartTimeUtc</maml:name> <maml:Description> <maml:para> The start time of a lookup query in ISO UTC yyyy-MM-ddTHH:mm:ssZ. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="1"> <maml:name>EndTimeUtc</maml:name> <maml:Description> <maml:para> The end time of a lookup query in ISO UTC yyyy-MM-ddTHH:mm:ssZ. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="2"> <maml:name>NodeName</maml:name> <maml:Description> <maml:para> The name of the node. </maml:para> </maml:Description> <command:parameterValue required="true">NodeName</command:parameterValue> <dev:type> <maml:name>NodeName</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>EventsTypesFilter</maml:name> <maml:Description> <maml:para> This is a comma separated string specifying the types of FabricEvents that should only be included in the response. </maml:para> </maml:Description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>ExcludeAnalysisEvents</maml:name> <maml:Description> <maml:para> This param disables the retrieval of AnalysisEvents if true is passed. </maml:para> </maml:Description> <command:parameterValue required="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>SkipCorrelationLookup</maml:name> <maml:Description> <maml:para> This param disables the search of CorrelatedEvents information if true is passed. otherwise the CorrelationEvents get processed and HasCorrelatedEvents field in every FabricEvent gets populated. </maml:para> </maml:Description> <command:parameterValue required="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-SFApplicationsEvent</command:name> <command:verb>Get</command:verb> <command:noun>ApplicationsEvent</command:noun> <maml:description> <maml:para>Gets all Applications-related events.</maml:para> </maml:description> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-SFApplicationsEvent</maml:name> <command:parameter required="true"> <maml:name>StartTimeUtc</maml:name> </command:parameter> <command:parameter required="true"> <maml:name>EndTimeUtc</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>ServerTimeout</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>EventsTypesFilter</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>ExcludeAnalysisEvents</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>SkipCorrelationLookup</maml:name> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-SFApplicationsEvent</maml:name> <command:parameter required="true"> <maml:name>StartTimeUtc</maml:name> </command:parameter> <command:parameter required="true"> <maml:name>EndTimeUtc</maml:name> </command:parameter> <command:parameter required="true"> <maml:name>ApplicationId</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>ServerTimeout</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>EventsTypesFilter</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>ExcludeAnalysisEvents</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>SkipCorrelationLookup</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <maml:description> <maml:para>The response is list of ApplicationEvent objects.</maml:para> </maml:description> <command:parameters> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="0"> <maml:name>StartTimeUtc</maml:name> <maml:Description> <maml:para> The start time of a lookup query in ISO UTC yyyy-MM-ddTHH:mm:ssZ. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="1"> <maml:name>EndTimeUtc</maml:name> <maml:Description> <maml:para> The end time of a lookup query in ISO UTC yyyy-MM-ddTHH:mm:ssZ. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="2"> <maml:name>ApplicationId</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>EventsTypesFilter</maml:name> <maml:Description> <maml:para> This is a comma separated string specifying the types of FabricEvents that should only be included in the response. </maml:para> </maml:Description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>ExcludeAnalysisEvents</maml:name> <maml:Description> <maml:para> This param disables the retrieval of AnalysisEvents if true is passed. </maml:para> </maml:Description> <command:parameterValue required="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>SkipCorrelationLookup</maml:name> <maml:Description> <maml:para> This param disables the search of CorrelatedEvents information if true is passed. otherwise the CorrelationEvents get processed and HasCorrelatedEvents field in every FabricEvent gets populated. </maml:para> </maml:Description> <command:parameterValue required="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-SFServicesEvent</command:name> <command:verb>Get</command:verb> <command:noun>ServicesEvent</command:noun> <maml:description> <maml:para>Gets all Services-related events.</maml:para> </maml:description> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-SFServicesEvent</maml:name> <command:parameter required="true"> <maml:name>StartTimeUtc</maml:name> </command:parameter> <command:parameter required="true"> <maml:name>EndTimeUtc</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>ServerTimeout</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>EventsTypesFilter</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>ExcludeAnalysisEvents</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>SkipCorrelationLookup</maml:name> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-SFServicesEvent</maml:name> <command:parameter required="true"> <maml:name>StartTimeUtc</maml:name> </command:parameter> <command:parameter required="true"> <maml:name>EndTimeUtc</maml:name> </command:parameter> <command:parameter required="true"> <maml:name>ServiceId</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>ServerTimeout</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>EventsTypesFilter</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>ExcludeAnalysisEvents</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>SkipCorrelationLookup</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <maml:description> <maml:para>The response is list of ServiceEvent objects.</maml:para> </maml:description> <command:parameters> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="0"> <maml:name>StartTimeUtc</maml:name> <maml:Description> <maml:para> The start time of a lookup query in ISO UTC yyyy-MM-ddTHH:mm:ssZ. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="1"> <maml:name>EndTimeUtc</maml:name> <maml:Description> <maml:para> The end time of a lookup query in ISO UTC yyyy-MM-ddTHH:mm:ssZ. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="2"> <maml:name>ServiceId</maml:name> <maml:Description> <maml:para> The identity of the service. This ID is typically the full name of the service without the 'fabric:' URI scheme. Starting from version 6.0, hierarchical names are delimited with the "~" character. For example, if the service name is "fabric:/myapp/app1/svc1", the service identity would be "myapp~app1~svc1" in 6.0+ and "myapp/app1/svc1" in previous versions. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>EventsTypesFilter</maml:name> <maml:Description> <maml:para> This is a comma separated string specifying the types of FabricEvents that should only be included in the response. </maml:para> </maml:Description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>ExcludeAnalysisEvents</maml:name> <maml:Description> <maml:para> This param disables the retrieval of AnalysisEvents if true is passed. </maml:para> </maml:Description> <command:parameterValue required="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>SkipCorrelationLookup</maml:name> <maml:Description> <maml:para> This param disables the search of CorrelatedEvents information if true is passed. otherwise the CorrelationEvents get processed and HasCorrelatedEvents field in every FabricEvent gets populated. </maml:para> </maml:Description> <command:parameterValue required="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-SFPartitionsEvent</command:name> <command:verb>Get</command:verb> <command:noun>PartitionsEvent</command:noun> <maml:description> <maml:para>Gets all Partitions-related events.</maml:para> </maml:description> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-SFPartitionsEvent</maml:name> <command:parameter required="true"> <maml:name>StartTimeUtc</maml:name> </command:parameter> <command:parameter required="true"> <maml:name>EndTimeUtc</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>ServerTimeout</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>EventsTypesFilter</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>ExcludeAnalysisEvents</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>SkipCorrelationLookup</maml:name> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-SFPartitionsEvent</maml:name> <command:parameter required="true"> <maml:name>StartTimeUtc</maml:name> </command:parameter> <command:parameter required="true"> <maml:name>EndTimeUtc</maml:name> </command:parameter> <command:parameter required="true"> <maml:name>PartitionId</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>ServerTimeout</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>EventsTypesFilter</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>ExcludeAnalysisEvents</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>SkipCorrelationLookup</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <maml:description> <maml:para>The response is list of PartitionEvent objects.</maml:para> </maml:description> <command:parameters> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="0"> <maml:name>StartTimeUtc</maml:name> <maml:Description> <maml:para> The start time of a lookup query in ISO UTC yyyy-MM-ddTHH:mm:ssZ. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="1"> <maml:name>EndTimeUtc</maml:name> <maml:Description> <maml:para> The end time of a lookup query in ISO UTC yyyy-MM-ddTHH:mm:ssZ. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="2"> <maml:name>PartitionId</maml:name> <maml:Description> <maml:para> The identity of the partition. </maml:para> </maml:Description> <command:parameterValue required="true">PartitionId</command:parameterValue> <dev:type> <maml:name>PartitionId</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="3"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>EventsTypesFilter</maml:name> <maml:Description> <maml:para> This is a comma separated string specifying the types of FabricEvents that should only be included in the response. </maml:para> </maml:Description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>ExcludeAnalysisEvents</maml:name> <maml:Description> <maml:para> This param disables the retrieval of AnalysisEvents if true is passed. </maml:para> </maml:Description> <command:parameterValue required="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>SkipCorrelationLookup</maml:name> <maml:Description> <maml:para> This param disables the search of CorrelatedEvents information if true is passed. otherwise the CorrelationEvents get processed and HasCorrelatedEvents field in every FabricEvent gets populated. </maml:para> </maml:Description> <command:parameterValue required="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-SFPartitionReplicasEvent</command:name> <command:verb>Get</command:verb> <command:noun>PartitionReplicasEvent</command:noun> <maml:description> <maml:para>Gets all Replicas-related events for a Partition.</maml:para> </maml:description> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-SFPartitionReplicasEvent</maml:name> <command:parameter required="true"> <maml:name>PartitionId</maml:name> </command:parameter> <command:parameter required="true"> <maml:name>StartTimeUtc</maml:name> </command:parameter> <command:parameter required="true"> <maml:name>EndTimeUtc</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>ServerTimeout</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>EventsTypesFilter</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>ExcludeAnalysisEvents</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>SkipCorrelationLookup</maml:name> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-SFPartitionReplicasEvent</maml:name> <command:parameter required="true"> <maml:name>PartitionId</maml:name> </command:parameter> <command:parameter required="true"> <maml:name>StartTimeUtc</maml:name> </command:parameter> <command:parameter required="true"> <maml:name>EndTimeUtc</maml:name> </command:parameter> <command:parameter required="true"> <maml:name>ReplicaId</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>ServerTimeout</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>EventsTypesFilter</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>ExcludeAnalysisEvents</maml:name> </command:parameter> <command:parameter required="false"> <maml:name>SkipCorrelationLookup</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <maml:description> <maml:para>The response is list of ReplicaEvent objects.</maml:para> </maml:description> <command:parameters> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="0"> <maml:name>PartitionId</maml:name> <maml:Description> <maml:para> The identity of the partition. </maml:para> </maml:Description> <command:parameterValue required="true">PartitionId</command:parameterValue> <dev:type> <maml:name>PartitionId</maml:name> </dev:type> </command:parameter> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="1"> <maml:name>StartTimeUtc</maml:name> <maml:Description> <maml:para> The start time of a lookup query in ISO UTC yyyy-MM-ddTHH:mm:ssZ. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="2"> <maml:name>EndTimeUtc</maml:name> <maml:Description> <maml:para> The end time of a lookup query in ISO UTC yyyy-MM-ddTHH:mm:ssZ. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="3"> <maml:name>ReplicaId</maml:name> <maml:Description> <maml:para> The identifier of the replica. </maml:para> </maml:Description> <command:parameterValue required="true">ReplicaId</command:parameterValue> <dev:type> <maml:name>ReplicaId</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="5"> <maml:name>EventsTypesFilter</maml:name> <maml:Description> <maml:para> This is a comma separated string specifying the types of FabricEvents that should only be included in the response. </maml:para> </maml:Description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="6"> <maml:name>ExcludeAnalysisEvents</maml:name> <maml:Description> <maml:para> This param disables the retrieval of AnalysisEvents if true is passed. </maml:para> </maml:Description> <command:parameterValue required="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="7"> <maml:name>SkipCorrelationLookup</maml:name> <maml:Description> <maml:para> This param disables the search of CorrelatedEvents information if true is passed. otherwise the CorrelationEvents get processed and HasCorrelatedEvents field in every FabricEvent gets populated. </maml:para> </maml:Description> <command:parameterValue required="false">bool?</command:parameterValue> <dev:type> <maml:name>bool?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-SFCorrelatedEventList</command:name> <command:verb>Get</command:verb> <command:noun>CorrelatedEventList</command:noun> <maml:description> <maml:para>Gets all correlated events for a given event.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>The response is list of FabricEvents.</maml:para> </maml:description> <command:parameters> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="0"> <maml:name>EventInstanceId</maml:name> <maml:Description> <maml:para> The EventInstanceId. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="1"> <maml:name>ServerTimeout</maml:name> <maml:Description> <maml:para> 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. </maml:para> </maml:Description> <command:parameterValue required="false">long?</command:parameterValue> <dev:type> <maml:name>long?</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-SFMeshSecret</command:name> <command:verb>Remove</command:verb> <command:noun>MeshSecret</command:noun> <maml:description> <maml:para>Deletes the Secret resource.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Deletes the specified Secret resource and all of its named values.</maml:para> </maml:description> <command:parameters> <command:parameter required="true" position="0"> <maml:name>SecretResourceName</maml:name> <maml:Description> <maml:para> The name of the secret resource. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-SFMeshSecret</command:name> <command:verb>Get</command:verb> <command:noun>MeshSecret</command:noun> <maml:description> <maml:para>Lists all the secret resources.</maml:para> </maml:description> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-SFMeshSecret</maml:name> <command:parameter required="true"> <maml:name>SecretResourceName</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <maml:description> <maml:para>Gets the information about all secret resources in a given resource group. The information include the description and other properties of the Secret.</maml:para> </maml:description> <command:parameters> <command:parameter required="true" position="0"> <maml:name>SecretResourceName</maml:name> <maml:Description> <maml:para> The name of the secret resource. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-SFMeshSecretValue</command:name> <command:verb>Get</command:verb> <command:noun>MeshSecretValue</command:noun> <maml:description> <maml:para>Gets the specified secret value resource.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Get the information about the specified named secret value resources. The information does not include the actual value of the secret.</maml:para> </maml:description> <command:parameters> <command:parameter required="true" position="0"> <maml:name>SecretResourceName</maml:name> <maml:Description> <maml:para> The name of the secret resource. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>SecretValueResourceName</maml:name> <maml:Description> <maml:para> The name of the secret resource value which is typically the version identifier for the value. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-SFMeshSecretValue</command:name> <command:verb>Remove</command:verb> <command:noun>MeshSecretValue</command:noun> <maml:description> <maml:para>Deletes the specified value of the named secret resource.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Deletes the secret value resource identified by the name. The name of the resource is typically the version associated with that value. Deletion will fail if the specified value is in use. </maml:para> </maml:description> <command:parameters> <command:parameter required="true" position="0"> <maml:name>SecretResourceName</maml:name> <maml:Description> <maml:para> The name of the secret resource. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>SecretValueResourceName</maml:name> <maml:Description> <maml:para> The name of the secret resource value which is typically the version identifier for the value. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-SFMeshSecretValue</command:name> <command:verb>Get</command:verb> <command:noun>MeshSecretValue</command:noun> <maml:description> <maml:para>List names of all values of the specified secret resource.</maml:para> </maml:description> </command:details> <command:syntax> <command:syntaxItem> <maml:name>Get-SFMeshSecretValue</maml:name> <command:parameter required="true"> <maml:name>SecretResourceName</maml:name> </command:parameter> </command:syntaxItem> </command:syntax> <maml:description> <maml:para>Gets information about all secret value resources of the specified secret resource. The information includes the names of the secret value resources, but not the actual values.</maml:para> </maml:description> <command:parameters> <command:parameter required="true" position="0"> <maml:name>SecretResourceName</maml:name> <maml:Description> <maml:para> The name of the secret resource. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Show-SFMeshSecretValue</command:name> <command:verb>Show</command:verb> <command:noun>MeshSecretValue</command:noun> <maml:description> <maml:para>Lists the specified value of the secret resource.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Lists the decrypted value of the specified named value of the secret resource. This is a privileged operation.</maml:para> </maml:description> <command:parameters> <command:parameter required="true" position="0"> <maml:name>SecretResourceName</maml:name> <maml:Description> <maml:para> The name of the secret resource. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>SecretValueResourceName</maml:name> <maml:Description> <maml:para> The name of the secret resource value which is typically the version identifier for the value. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-SFMeshVolume</command:name> <command:verb>Remove</command:verb> <command:noun>MeshVolume</command:noun> <maml:description> <maml:para>Deletes the Volume resource.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Deletes the Volume resource identified by the name.</maml:para> </maml:description> <command:parameters> <command:parameter required="true" position="0"> <maml:name>VolumeResourceName</maml:name> <maml:Description> <maml:para> The identity of the volume. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-SFMeshVolume</command:name> <command:verb>Get</command:verb> <command:noun>MeshVolume</command:noun> <maml:description> <maml:para>Lists all the volume resources.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Gets the information about all volume resources in a given resource group. The information include the description and other properties of the Volume.</maml:para> </maml:description> <command:parameters> <command:parameter required="true" position="0"> <maml:name>VolumeResourceName</maml:name> <maml:Description> <maml:para> The identity of the volume. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-SFMeshNetwork</command:name> <command:verb>Remove</command:verb> <command:noun>MeshNetwork</command:noun> <maml:description> <maml:para>Deletes the Network resource.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Deletes the Network resource identified by the name.</maml:para> </maml:description> <command:parameters> <command:parameter required="true" position="0"> <maml:name>NetworkResourceName</maml:name> <maml:Description> <maml:para> The identity of the network. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-SFMeshNetwork</command:name> <command:verb>Get</command:verb> <command:noun>MeshNetwork</command:noun> <maml:description> <maml:para>Lists all the network resources.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Gets the information about all network resources in a given resource group. The information include the description and other properties of the Network.</maml:para> </maml:description> <command:parameters> <command:parameter required="true" position="0"> <maml:name>NetworkResourceName</maml:name> <maml:Description> <maml:para> The identity of the network. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-SFMeshApplication</command:name> <command:verb>Remove</command:verb> <command:noun>MeshApplication</command:noun> <maml:description> <maml:para>Deletes the Application resource.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Deletes the Application resource identified by the name.</maml:para> </maml:description> <command:parameters> <command:parameter required="true" position="0"> <maml:name>ApplicationResourceName</maml:name> <maml:Description> <maml:para> The identity of the application. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-SFMeshApplication</command:name> <command:verb>Get</command:verb> <command:noun>MeshApplication</command:noun> <maml:description> <maml:para>Lists all the application resources.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Gets the information about all application resources in a given resource group. The information include the description and other properties of the Application.</maml:para> </maml:description> <command:parameters> <command:parameter required="true" position="0"> <maml:name>ApplicationResourceName</maml:name> <maml:Description> <maml:para> The identity of the application. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-SFMeshService</command:name> <command:verb>Get</command:verb> <command:noun>MeshService</command:noun> <maml:description> <maml:para>Lists all the service resources.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Gets the information about all services of an application resource. The information include the description and other properties of the Service.</maml:para> </maml:description> <command:parameters> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="0"> <maml:name>ApplicationResourceName</maml:name> <maml:Description> <maml:para> The identity of the application. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="1"> <maml:name>ServiceResourceName</maml:name> <maml:Description> <maml:para> The identity of the service. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-SFContainerLogsMeshCodePackage</command:name> <command:verb>Get</command:verb> <command:noun>ContainerLogsMeshCodePackage</command:noun> <maml:description> <maml:para>Gets the logs from the container.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Gets the logs for the container of the specified code package of the service replica.</maml:para> </maml:description> <command:parameters> <command:parameter required="true" position="0"> <maml:name>ApplicationResourceName</maml:name> <maml:Description> <maml:para> The identity of the application. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="1"> <maml:name>ServiceResourceName</maml:name> <maml:Description> <maml:para> The identity of the service. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="2"> <maml:name>ReplicaName</maml:name> <maml:Description> <maml:para> Service Fabric replica name. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="true" position="3"> <maml:name>CodePackageName</maml:name> <maml:Description> <maml:para> The name of code package of the service. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="false" position="4"> <maml:name>Tail</maml:name> <maml:Description> <maml:para> Number of lines to show from the end of the logs. Default is 100. 'all' to show the complete logs. </maml:para> </maml:Description> <command:parameterValue required="false">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-SFMeshServiceReplica</command:name> <command:verb>Get</command:verb> <command:noun>MeshServiceReplica</command:noun> <maml:description> <maml:para>Lists all the replicas of a service.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Gets the information about all replicas of a service. The information include the description and other properties of the service replica.</maml:para> </maml:description> <command:parameters> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="0"> <maml:name>ApplicationResourceName</maml:name> <maml:Description> <maml:para> The identity of the application. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="1"> <maml:name>ServiceResourceName</maml:name> <maml:Description> <maml:para> The identity of the service. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> <command:parameter required="true" pipelineInput="True(ByPropertyName)" position="2"> <maml:name>ReplicaName</maml:name> <maml:Description> <maml:para> Service Fabric replica name. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-SFMeshGateway</command:name> <command:verb>Remove</command:verb> <command:noun>MeshGateway</command:noun> <maml:description> <maml:para>Deletes the Gateway resource.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Deletes the Gateway resource identified by the name.</maml:para> </maml:description> <command:parameters> <command:parameter required="true" position="0"> <maml:name>GatewayResourceName</maml:name> <maml:Description> <maml:para> The identity of the gateway. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-SFMeshGateway</command:name> <command:verb>Get</command:verb> <command:noun>MeshGateway</command:noun> <maml:description> <maml:para>Lists all the gateway resources.</maml:para> </maml:description> </command:details> <command:syntax> </command:syntax> <maml:description> <maml:para>Gets the information about all gateway resources in a given resource group. The information include the description and other properties of the Gateway.</maml:para> </maml:description> <command:parameters> <command:parameter required="true" position="0"> <maml:name>GatewayResourceName</maml:name> <maml:Description> <maml:para> The identity of the gateway. </maml:para> </maml:Description> <command:parameterValue required="true">string</command:parameterValue> <dev:type> <maml:name>string</maml:name> </dev:type> </command:parameter> </command:parameters> </command:command> </helpItems> |