Skip to content

Updated help for ASRRMcmdlets #3560

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed

Updated help for ASRRMcmdlets #3560

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a734239
Updated help for ASRRMcmdlets
CFreemanwa Mar 2, 2017
e400a23
updating ASRSiterecovery cmdlets
CFreemanwa Mar 2, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17,465 changes: 7,836 additions & 9,629 deletions ...ger/SiteRecovery/Commands.SiteRecovery/Microsoft.Azure.Commands.SiteRecovery.dll-help.xml
View file
Open in desktop

Large diffs are not rendered by default.

12 changes: 8 additions & 4 deletions ...SiteRecovery/Commands.SiteRecovery/help/Edit-AzureRmSiteRecoveryRecoveryPlan.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ The **Edit-AzureRmSiteRecoveryRecoveryPlan** cmdlet edits an Azure Site Recovery
## PARAMETERS

### -RecoveryPlan
Specifies a recovery plan.
An instance of an ASRRecoveryPlan to edit.

```yaml
Type: ASRRecoveryPlan
Expand Down Expand Up @@ -100,7 +100,7 @@ Accept wildcard characters: False
```

### -Group
Specifies a Site Recovery plan group.
An instance of the ASRRecoveryPlanGroup which the plan belongs to.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Its actually the other way around. Recovery Plan Groups are groupings under the recovery plan. There could be multiple Recovery plan groups in a recovery plan. I'd prefer we call it "Recovery Plan" and "Recovery Plan Group" as those are the nouns for these constructs. The class definition has ASR prefixed to distinguish this as an Azure Site Recovery (ASR) construct.


```yaml
Type: ASRRecoveryPlanGroup
Expand All @@ -115,6 +115,8 @@ Accept wildcard characters: False
```

### -AddProtectedItems
An instance of an ASRReplicationProtectedItem.

```yaml
Type: ASRReplicationProtectedItem[]
Parameter Sets: AddReplicationProtectedItems
Expand All @@ -128,7 +130,7 @@ Accept wildcard characters: False
```

### -AddProtectedEntities
Specifies an array of protected entities to add.
An instance of an ASRProtectionEntity array of protected entities to add.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

An instance of an array seems confusing. This is an array of ASRProtectionEntity instances to add


```yaml
Type: ASRProtectionEntity[]
Expand All @@ -143,7 +145,7 @@ Accept wildcard characters: False
```

### -RemoveProtectedEntities
Specifies an array of protected entities.
An instance of an ASRProtectionEntity array of protected entities to remove.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

An instance of an array seems confusing. This is an array of ASRProtectionEntity instances to remove


```yaml
Type: ASRProtectionEntity[]
Expand All @@ -158,6 +160,8 @@ Accept wildcard characters: False
```

### -RemoveProtectedItems
An instance of an ASRReplicationProtectedItem.

```yaml
Type: ASRReplicationProtectedItem[]
Parameter Sets: RemoveReplicationProtectedItems
Expand Down
14 changes: 12 additions & 2 deletions ...nager/SiteRecovery/Commands.SiteRecovery/help/Get-AzureRmSiteRecoveryNetwork.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,9 +52,17 @@ The **Get-AzureRmSiteRecoveryNetwork** cmdlet gets information about Azure Site

## EXAMPLES

### Example 1: Get an instance of an AzureRMSiteRecoveryNetwork
```
Get-AzureRMSiteRecoveryNetwork -Name "ASRServer1" -Fabric "ASRFabric1"
```


## PARAMETERS

### -Server
An instance of an ASRServer object.

```yaml
Type: ASRServer
Parameter Sets: ByFriendlyNameLegacy, ByNameLegacy, ByServerObject
Expand All @@ -68,7 +76,7 @@ Accept wildcard characters: False
```

### -Name
Specifies the name of the virtual machine network.
A string specifying the name of the virtual machine network.

```yaml
Type: String
Expand All @@ -95,7 +103,7 @@ Accept wildcard characters: False
```

### -FriendlyName
Specifies the friendly name of the virtual machine network.
A string specifying the friendly name of the virtual machine network.

```yaml
Type: String
Expand All @@ -122,6 +130,8 @@ Accept wildcard characters: False
```

### -Fabric
An instance of an ASRFabric object.

```yaml
Type: ASRFabric
Parameter Sets: ByFriendlyName, ByName, ByFabricObject
Expand Down
8 changes: 8 additions & 0 deletions ...iteRecovery/Commands.SiteRecovery/help/Get-AzureRmSiteRecoveryNetworkMapping.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,8 @@ The **Get-AzureRmSiteRecoveryNetworkMapping** cmdlet gets information about Azur
## PARAMETERS

### -PrimaryFabric
An instance of an ASRFabric object.

```yaml
Type: ASRFabric
Parameter Sets: EnterpriseToEnterprise, EnterpriseToAzure
Expand Down Expand Up @@ -75,6 +77,8 @@ Accept wildcard characters: False
```

### -RecoveryFabric
An instance of an ASRFabric object.

```yaml
Type: ASRFabric
Parameter Sets: EnterpriseToEnterprise
Expand All @@ -88,6 +92,8 @@ Accept wildcard characters: False
```

### -PrimaryServer
An instance of an ASRServer object.

```yaml
Type: ASRServer
Parameter Sets: EnterpriseToAzureLegacy, EnterpriseToEnterpriseLegacy
Expand All @@ -101,6 +107,8 @@ Accept wildcard characters: False
```

### -RecoveryServer
An instance of an ASRServer object.

```yaml
Type: ASRServer
Parameter Sets: EnterpriseToEnterpriseLegacy
Expand Down
6 changes: 4 additions & 2 deletions ...covery/Commands.SiteRecovery/help/Get-AzureRmSiteRecoveryProtectionContainer.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ Protection policies define replication settings for protected items and can be a
## PARAMETERS

### -Name
Specifies the name of the protection container.
A string specifying the name of the protection container.

```yaml
Type: String
Expand All @@ -67,6 +67,8 @@ Accept wildcard characters: False
```

### -Fabric
An instance of an ASRFabric object.

```yaml
Type: ASRFabric
Parameter Sets: ByObjectWithName, ByObjectWithFriendlyName, ByFabricObject
Expand All @@ -80,7 +82,7 @@ Accept wildcard characters: False
```

### -FriendlyName
Specifies the friendly name of the protection container.
A string specifying the friendly name of the protection container.

```yaml
Type: String
Expand Down
5 changes: 5 additions & 0 deletions ...anager/SiteRecovery/Commands.SiteRecovery/help/Get-AzureRmSiteRecoveryServer.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,11 @@ The **Get-AzureRmSiteRecoveryServer** cmdlet gets information about Azure Site R

## EXAMPLES

### Example 1 Get a Site Recovery Server by name
```
PS C:\> $ASRServer = Get-AzureRmSiteRecoveryServer -ByName "ASRServer1"
```

## PARAMETERS

### -Name
Expand Down
4 changes: 4 additions & 0 deletions ...very/Commands.SiteRecovery/help/Get-AzureRmSiteRecoveryStorageClassification.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,8 @@ Accept wildcard characters: False
```

### -Fabric
An instance of an ASRFabric object.

```yaml
Type: ASRFabric
Parameter Sets: ByFabricObject
Expand All @@ -88,6 +90,8 @@ Accept wildcard characters: False
```

### -Server
An instance of an ASRServer object.

```yaml
Type: ASRServer
Parameter Sets: ByServerObject
Expand Down
27 changes: 17 additions & 10 deletions ...anager/SiteRecovery/Commands.SiteRecovery/help/New-AzureRmSiteRecoveryPolicy.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ The replication policy is used to specify replication settings such as the repli
## PARAMETERS

### -Name
Specifies a friendly name which identifies the Site Recovery replication policy.
A string specifying a friendly name which identifies the Site Recovery replication policy.

```yaml
Type: String
Expand All @@ -52,7 +52,7 @@ Accept wildcard characters: False
```

### -ReplicationProvider
Specifies the replication provider.
A string specifying the replication provider.
Valid values are:

- HyperVReplica2012R2
Expand All @@ -72,7 +72,7 @@ Accept wildcard characters: False
```

### -ReplicationFrequencyInSeconds
Specifies the replication frequency interval in seconds.
A string specifying the replication frequency interval in seconds.
Valid values are:

- 30
Expand All @@ -92,7 +92,7 @@ Accept wildcard characters: False
```

### -RecoveryPoints
Specifies the number of hours to retain recovery points.
An integer specifying the number of hours to retain recovery points.

```yaml
Type: Int32
Expand All @@ -107,7 +107,7 @@ Accept wildcard characters: False
```

### -ApplicationConsistentSnapshotFrequencyInHours
Specifies the frequency of the application consistent snapshot in hours.
An integer specifying the frequency of the application consistent snapshot in hours.

```yaml
Type: Int32
Expand All @@ -122,7 +122,7 @@ Accept wildcard characters: False
```

### -ReplicationStartTime
Specifies the replication start time.
An instance of a TimeeSpan object specifying the replication start time.
It must be no later than 24-hours from the start of the job.

```yaml
Expand All @@ -138,7 +138,7 @@ Accept wildcard characters: False
```

### -RecoveryAzureStorageAccountId
Specifies the Azure storage account ID of the replication target.
A string specifying the Azure storage account ID of the replication target.

```yaml
Type: String
Expand All @@ -153,6 +153,8 @@ Accept wildcard characters: False
```

### -Encryption
A string specifying the EnterpriseToAzure parameter set.

```yaml
Type: String
Parameter Sets: EnterpriseToAzure
Expand All @@ -166,7 +168,7 @@ Accept wildcard characters: False
```

### -ReplicationMethod
Specifies the replication method.
A string specifying the replication method.
Valid values are:

- Online
Expand All @@ -185,6 +187,8 @@ Accept wildcard characters: False
```

### -Compression
A string indicating whether compression should be enabled on the policy.

```yaml
Type: String
Parameter Sets: EnterpriseToEnterprise
Expand All @@ -198,7 +202,7 @@ Accept wildcard characters: False
```

### -ReplicationPort
Specifies the port used for replication.
An integer specifying the port used for replication.

```yaml
Type: UInt16
Expand All @@ -213,7 +217,7 @@ Accept wildcard characters: False
```

### -Authentication
Specifies the type of authentication used.
A string specifying the type of authentication used.
Valid values are:

- Certificate
Expand All @@ -232,6 +236,9 @@ Accept wildcard characters: False
```

### -ReplicaDeletion
A string indicating whether Replica should be Deleted on
disabling protection of a protection entity protected by the Policy.

```yaml
Type: String
Parameter Sets: EnterpriseToEnterprise
Expand Down
20 changes: 20 additions & 0 deletions .../SiteRecovery/Commands.SiteRecovery/help/New-AzureRmSiteRecoveryRecoveryPlan.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,8 @@ This command adds the recovery plan named RecoveryPlan.xml to the Azure Site Rec
## PARAMETERS

### -Name
A string specifying the name of the recovery plan.

```yaml
Type: String
Parameter Sets: EnterpriseToEnterprise, EnterpriseToAzure, HyperVSiteToAzureLegacy, EnterpriseToEnterpriseLegacy, EnterpriseToAzureLegacy
Expand All @@ -78,6 +80,8 @@ Accept wildcard characters: False
```

### -PrimaryFabric
A instance of an ASRFabric object.

```yaml
Type: ASRFabric
Parameter Sets: EnterpriseToEnterprise, EnterpriseToAzure
Expand All @@ -91,6 +95,8 @@ Accept wildcard characters: False
```

### -RecoveryFabric
An instance of an ASRFabric object.

```yaml
Type: ASRFabric
Parameter Sets: EnterpriseToEnterprise
Expand All @@ -104,6 +110,8 @@ Accept wildcard characters: False
```

### -ReplicationProtectedItem
An instance of an ASRReplicationProtectedItem.

```yaml
Type: ASRReplicationProtectedItem[]
Parameter Sets: EnterpriseToEnterprise, EnterpriseToAzure
Expand All @@ -117,6 +125,8 @@ Accept wildcard characters: False
```

### -FailoverDeploymentModel
A string specifying the failover deployment model.

```yaml
Type: String
Parameter Sets: EnterpriseToAzure, HyperVSiteToAzureLegacy, EnterpriseToAzureLegacy
Expand All @@ -130,6 +140,8 @@ Accept wildcard characters: False
```

### -PrimarySite
An instance of an ASRSite object.

```yaml
Type: ASRSite
Parameter Sets: HyperVSiteToAzureLegacy
Expand All @@ -143,6 +155,8 @@ Accept wildcard characters: False
```

### -ProtectionEntityList
An instance of an ASRProtectionEntity

```yaml
Type: ASRProtectionEntity[]
Parameter Sets: HyperVSiteToAzureLegacy, EnterpriseToEnterpriseLegacy, EnterpriseToAzureLegacy
Expand All @@ -156,6 +170,8 @@ Accept wildcard characters: False
```

### -Azure
An instance of a SwitchParameter.

```yaml
Type: SwitchParameter
Parameter Sets: EnterpriseToAzure, EnterpriseToAzureLegacy
Expand All @@ -169,6 +185,8 @@ Accept wildcard characters: False
```

### -PrimaryServer
An instance of a PrimaryServer object.

```yaml
Type: ASRServer
Parameter Sets: EnterpriseToEnterpriseLegacy, EnterpriseToAzureLegacy
Expand All @@ -182,6 +200,8 @@ Accept wildcard characters: False
```

### -RecoveryServer
An instance of an ASRServer object.

```yaml
Type: ASRServer
Parameter Sets: EnterpriseToEnterpriseLegacy
Expand Down
Loading