Get-AzNetAppFilesCachePeeringPassphrase

Module:

Az.NetAppFiles Module

Gets the cluster-peering and vserver-peering commands and passphrases required to complete peering between an Azure NetApp Files (ANF) Cache and its on-prem ONTAP origin.

Syntax

ByFieldsParameterSet (Default)

Get-AzNetAppFilesCachePeeringPassphrase
    -ResourceGroupName <String>
    -AccountName <String>
    -PoolName <String>
    -Name <String>
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

ByResourceIdParameterSet

Get-AzNetAppFilesCachePeeringPassphrase
    -ResourceId <String>
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

ByObjectParameterSet

Get-AzNetAppFilesCachePeeringPassphrase
    -InputObject <PSNetAppFilesCache>
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

Description

The Get-AzNetAppFilesCachePeeringPassphrase cmdlet returns the cluster peering command, the cluster peering passphrase, and the vserver peering command that must be executed on the external ONTAP origin cluster to complete FlexCache peering. If any critical warnings apply to the peering operation, they are returned in the CriticalWarning property.

Examples

Example 1: Retrieve peering commands for a Cache

Get-AzNetAppFilesCachePeeringPassphrase -ResourceGroupName "MyRG" -AccountName "MyAnfAccount" -PoolName "MyAnfPool" -Name "MyAnfCache"

ClusterPeeringCommand    : cluster peer create -address-family ipv4 -peer-addrs ...
ClusterPeeringPassphrase : ****************
VserverPeeringCommand    : vserver peer create -vserver onprem-svm -peer-vserver ...
CriticalWarning          :

Returns the commands and passphrase needed to accept cluster peering on the origin ONTAP cluster.

Parameters

-AccountName

The name of the ANF account

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

ByFieldsParameterSet

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

Parameter properties

Type:	IAzureContextContainer
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	AzContext, AzureRmContext, AzureCredential

Parameter sets

(All)

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-InputObject

The cache object

Parameter properties

Type:	PSNetAppFilesCache
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

ByObjectParameterSet

Position:	Named
Mandatory:	True
Value from pipeline:	True
Value from pipeline by property name:	False
Value from remaining arguments:	False

-Name

The name of the ANF cache

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	CacheName

Parameter sets

ByFieldsParameterSet

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-PoolName

The name of the ANF capacity pool

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

ByFieldsParameterSet

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-ResourceGroupName

The resource group of the ANF account

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

ByFieldsParameterSet

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-ResourceId

The resource id of the ANF cache

Parameter properties

Type:	String
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

ByResourceIdParameterSet

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	True
Value from remaining arguments:	False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

String

PSNetAppFilesCache

Outputs

PSNetAppFilesCachePeeringPassphrase