Get-VipHostMapping
Gets VIP host mapping.
Syntax
Default (Default)
Get-VipHostMapping
[-NetworkController] <String>
[[-Credential] <PSCredential>]
[-RestURI] <String>
[[-CertificateThumbprint] <String>]
[-VipEndPoint] <String>
[-Type] <String>
[<CommonParameters>]
Description
The Get-VipHostMapping cmdlet gets information for a virtual IP (VIP) host, including its multiplexers (MUXes) and DIP hosts.
Examples
Example 1: Get a VIP host mapping
PS C:\> $Password = ConvertTo-SecureString -String $Pass -AsPlainText -Force
PS C:\> $Cred = New-Object PSCredential -ArgumentList (".\administrator", $Password)
PS C:\> $ncIPAddress = 55.1.1.3
PS C:\> $NCInfo = Get-NetworkControllerDeploymentInfo -NetworkController $ncIPAddress -Credential $Cred
PS C:\> $vipInfo = Get-NetworkControllerVipResource -RestURI $NCInfo.NetworkControllerURI -ClientCertificate $NCInfo.ClientCertificate -IPAddress "72.1.12" -DstPort "2003" -Protocol "Tcp"
PS C:\> Get-VipHostMapping -NetworkController $ncIPAddress -Credential $Cred -RestURI $NCInfo.NetworkControllerURI -CertificateThumbprint $NCInfo.ClientCertificate -VipEndPoint $vipInfo.ResourceRef -L3NAT $vipInfo.L3NAT
The first command creates a password, and then stores it in the $Password variable.
The second command creates a PSCredential object, and then stores it in the $Cred variable.
The third command assigns the specified Network Controller IP address to the $ncIPAddress variable.
The fourth command gets the Network Controller deployment information, and then stores it in the $NCInfo variable.
The fifth command gets the specified VIP resource, and then stores it in the $vipInfo variable.
The last command gets the VIP host mapping for the specified host.
Parameters
-CertificateThumbprint
Specifies a certificate thumbprint for Network Controller. Specify this parameter for a certificate deployment.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 3 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Credential
Specifies the credentials to use for Network Controller. Specify this parameter for a Kerberos deployment.
Parameter properties
| Type: | PSCredential |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 1 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-NetworkController
Specifies a Network Controller node name or IP address.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-RestURI
Specifies the URI to use for Network Controller REST APIs. Specify this parameter for wild card certificate deployments.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 2 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Type
Specifies the type. The acceptable values for this parameter are:
- L3Nat
- InboundNatRule
- LoadBalancingRule
- OutboundNatRule
Parameter properties
| Type: | String |
| Default value: | None |
| Accepted values: | L3Nat, InboundNatRule, LoadBalancingRule, OutboundNatRule |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 5 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-VipEndPoint
Specifies the VIP endpoint REST resource.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 4 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| 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.