NetScaler:LBVirtualServer

Provisions a Citrix NetScaler load balancer virtual server (VIP).

Important

The NetScaler:LBVirtualServer resource type is not a native resource in POSHOrigin but provided by the POSHOrigin_NetScaler DSC module and must be installed in the provisioning system's $env:psmodulepath.

Parameters

Name	Type	Required	Description
Name	string	True	Name of VIP to create
Ensure	string	False	Denotes if resource should exist or not exist.
NetScalerFQDN	string	False	FQDN of the NetScaler to create the resource on
Credential	pscredential	False	Credential to authenticate with the NetScaler with. AdminUser object in the secrets section.
IPAddress	string	False	IP address of the VIP
Port	int	False	Port the VIP should listen on
ServiceType	string	False	Service type for VIP
LBMethod	string	False	Load balance method
Comments	string	False	Comments associated with VIP
State	string	False	State of the VIP. ENABLED, DISABLED

Example

my_ns_resource.ps1

resource 'NetScaler:LBVirtualServer' 'VM01_VIP' @{
    description = 'this is a comment'    
    ipAddress = '192.168.100.100'
    port = 80
    serviceType = 'HTTP'
    lbMethod = 'ROUNDROBIN'
    netScalerFQDN = '<NetScaler FQDN>'
    credential = Get-POSHOriginSecret 'pscredential' @{
        username = 'admin'
        password = '<your password>'
    }
}