Edit

Share via

New-NetworkControllerVirtualServer

  • Reference
Module:
NetworkController

Adds a new virtual server to the Network Controller. If already present, updates the properties of the virtual server

Syntax

New-NetworkControllerVirtualServer
   [-ResourceId] <String>
   [-MarkServerReadOnly] <Boolean>
   [[-Tags] <PSObject>]
   [-Properties] <VirtualServerProperties>
   [[-Etag] <String>]
   [[-ResourceMetadata] <ResourceMetadata>]
   [-Force]
   -ConnectionUri <Uri>
   [-CertificateThumbprint <String>]
   [-Credential <PSCredential>]
   [-PassInnerException]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

Adds a new virtual server to the Network Controller. If already present, updates the properties of the virtual server

Examples

Example 1

$credentialProperties = [Microsoft.Windows.NetworkController.CredentialProperties]@{Type="UsernamePassword";UserName="admin";Value="password"}
New-NetworkControllerCredential -ResourceId cred1 -ConnectionUri https://restserver -Properties $credentialProperties
$credential= Get-NetworkControllerCredential -ResourceId cred1 -ConnectionUri https://restserver

$virtualserverproperties=New-Object Microsoft.Windows.NetworkController.VirtualServerProperties
$virtualserverproperties.Connections = @([Microsoft.Windows.NetworkController.Connection]@{ManagementAddresses=@("192.168.0.12");Credential=$credential})
$virtualserverproperties.VMGuid="a85b4174-1547-4d55-ad5b-aa309f450d2f"
New-NetworkControllerVirtualServer -ConnectionUri https://restserver -ResourceId VirtualServer1 -Properties $virtualserverproperties

Description

The above cmdlet adds a virtual server with name VirtualServer1 to the Network Controller

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

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
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

-Etag

Specifies the entity tag (ETag) parameter of the resource. An ETag (entity tag) is an HTTP response header returned by an HTTP-compliant web server used to determine change in the content of a resource at a given URL. The value of the header is an opaque string representing the state of the resource at the time the response was generated.

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

-Force

Forces the command to run without asking for user confirmation.

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

-MarkServerReadOnly

@{Text=}

Type:Boolean
Position:Named
Default value:None
Required:True
Accept pipeline input:True
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

-Properties

Following properties of server can be added/modified: 1. List of connections that specifies the information needed to connect to the virtual server for the purposes of managing it. Each connection will have a management address and a credential reference to connect to the virtual server 2. VM network GUID associated with the virtual server 3. Virtual server certificate (needs to be populated only when the virtual server uses a self signed certificate) 4. Physical server where the virtual server is hosted

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

-ResourceId

Specifies the unique ID of the virtual server

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

-ResourceMetadata

This parameter contains metadata information for the client, such as the tenant ID, group ID, and resource name.

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

-Tags

@{Text=}

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

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

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

Inputs

String

Boolean

Microsoft.Windows.NetworkController.VirtualServerProperties

Following properties of server can be added/modified: 1. List of connections that specifies the information needed to connect to the virtual server for the purposes of managing it. Each connection will have a management address and a credential reference to connect to the virtual server 2. VM network GUID associated with the virtual server 3. Virtual server certificate (needs to be populated only when the virtual server uses a self signed certificate) 4. Physical server where the virtual server is hosted

Outputs

Object