Get-NetworkControllerServiceInsertion

  • Reference
Module:
NetworkController

This cmdlet retrieves the properties of a service insertion resource from the Network Controller.

Syntax

Get-NetworkControllerServiceInsertion
   [[-ResourceId] <String[]>]
   -ConnectionUri <Uri>
   [-CertificateThumbprint <String>]
   [-Credential <PSCredential>]
   [-PassInnerException]
   [<CommonParameters>]

Description

This cmdlet retrieves the properties of a service insertion resource from the Network Controller. Service insertion is useful for cases like port mirroring, so that traffic from one VM can be mirrored to another VM, say for inspection purposes.

Examples

Example 1

This example retrieves the properties of a service insertion resource named SI1, from the Network Controller.

Get-NetworkControllerServiceInsertion -ConnectionUri https://networkcontroller -ResourceId SI1

Parameters

-CertificateThumbprint

Specifies the digital public key X.509 certificate of a user account that has permission to perform this action.This is the certificate thumbprint of the certificate.This thumbprint must also be provided in the ClientCertificateThumbprint parameter in the Install-NetworkController or Set-NetworkController cmdlet so that Network Controller can authorize this user.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ConnectionUri

Specifies the Uniform Resource Identifier (URI) of the Network Controller, used by all Representational State Transfer (REST) clients to connect to Network Controller.

Type:Uri
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Credential

Specifies a user credential that has permission to perform this action.The default value is the current user.This user must be present in the security group provided in the ClientSecurityGroup parameter in the Install-NetworkController cmdlet.

Type:PSCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-PassInnerException

This thumbprint must also be provided in the ClientCertificateThumbprint parameter in the Install-NetworkController or Set-NetworkController cmdlet so that Network Controller can authorize this user.

The thumbprint must be provided only if the network controller client authentication is X509 certificates. Get-NetworkController retrieves that client authentication and authorization information.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ResourceId

Specifies the unique identifier for the service insertion resource.

Type:String[]
Position:0
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

None

Outputs

Object

Following properties for service insertion can be retrieved: For each service insertion rule, the following can be specified:

  1. Description of rule
  2. Protocol
  3. Starting source port
  4. Ending source port
  5. Starting destination port
  6. Ending destination port
  7. Source subnet(s)
  8. Destination subnet(s)

For each destination element where service insertion has to be applied:

  1. Description
  2. Destination network interface
  3. Order of the element