Set-SCNetworkGateway

Set-SCNetworkGateway

Sets the properties of a network gateway object.

Syntax

Parameter Set: Default
Set-SCNetworkGateway [-NetworkGateway] <NetworkServiceBase> [-ConfigurationProvider <ConfigurationProvider> ] [-ConnectionString <String> ] [-Description <String> ] [-JobVariable <String> ] [-Manufacturer <String> ] [-Model <String> ] [-Name <String> ] [-PROTipID <Guid]> ] [-RunAsAccount <RunAsAccount> ] [-RunAsynchronously] [-VMMServer <ServerConnection> ] [ <CommonParameters>]

Detailed Description

The Set-SCNetworkGateway cmdlet updates the properties of a network gateway object.

Parameters

-ConfigurationProvider<ConfigurationProvider>

Specifies a configuration provider object. A configuration provider is a plug-in to VMM that translates VMM PowerShell commands to API calls that are specific to a type of load balancer. If no configuration provider is specified, VMM uses the Manufacturer and Model information to choose an available configuration provider. If no configuration provider is found, the load balancer is not added.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ConnectionString<String>

Specifies the information required to connect to the virtual switch extension manager.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Description<String>

States a description for the specified object.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-JobVariable<String>

Specifies that job progress is tracked and stored in the variable named by this parameter.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Manufacturer<String>

Specifies the name of the company that manufactured a physical device. Valid characters include:

-- letters (a-z)
-- numbers (0-9)
-- underscore (_)
-- hyphen(-)
-- dot(.)
-- single quote(')

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Model<String>

Specifies the model of a physical device.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Name<String>

Specifies the name of a VMM object.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-NetworkGateway<NetworkServiceBase>

Specifies a network gateway object.

To obtain a network gateway object, use the Get-SCNetworkGateway cmdlet.

Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

false

-PROTipID<Guid]>

Specifies the ID of the PRO tip that triggered this action. This allows for auditing of PRO tips.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-RunAsAccount<RunAsAccount>

Specifies a Run As account that contains credentials with permission to perform this action.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-RunAsynchronously

Indicates that the job runs asynchronously so that control returns to the command shell immediately.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-VMMServer<ServerConnection>

Specifies a VMM server object.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

Add-SCNetworkGateway

Get-SCNetworkGateway

Read-SCNetworkGateway

Remove-SCNetworkGateway

Test-SCNetworkGateway