Invoke-ADCUnsetCsvserver

SYNOPSIS

Unset Content Switching configuration Object.

SYNTAX

Invoke-ADCUnsetCsvserver [[-Name] <String>] [[-casesensitive] <Boolean>] [[-backupvserver] <Boolean>]
 [[-clttimeout] <Boolean>] [[-redirecturl] <Boolean>] [[-authn401] <Boolean>] [[-authentication] <Boolean>]
 [[-authenticationhost] <Boolean>] [[-authnvsname] <Boolean>] [[-pushvserver] <Boolean>]
 [[-pushlabel] <Boolean>] [[-tcpprofilename] <Boolean>] [[-httpprofilename] <Boolean>]
 [[-dbprofilename] <Boolean>] [[-l2conn] <Boolean>] [[-mysqlprotocolversion] <Boolean>]
 [[-mysqlserverversion] <Boolean>] [[-mysqlcharacterset] <Boolean>] [[-mysqlservercapabilities] <Boolean>]
 [[-appflowlog] <Boolean>] [[-netprofile] <Boolean>] [[-icmpvsrresponse] <Boolean>] [[-authnprofile] <Boolean>]
 [[-sothreshold] <Boolean>] [[-dnsprofilename] <Boolean>] [[-tcpprobeport] <Boolean>]
 [[-probeprotocol] <Boolean>] [[-quicprofilename] <Boolean>] [[-redirectfromport] <Boolean>]
 [[-httpsredirecturl] <Boolean>] [[-ipset] <Boolean>] [[-stateupdate] <Boolean>] [[-precedence] <Boolean>]
 [[-cacheable] <Boolean>] [[-somethod] <Boolean>] [[-sopersistence] <Boolean>]
 [[-sopersistencetimeout] <Boolean>] [[-sobackupaction] <Boolean>] [[-redirectportrewrite] <Boolean>]
 [[-downstateflush] <Boolean>] [[-disableprimaryondown] <Boolean>] [[-insertvserveripport] <Boolean>]
 [[-vipheader] <Boolean>] [[-rtspnat] <Boolean>] [[-listenpolicy] <Boolean>] [[-listenpriority] <Boolean>]
 [[-push] <Boolean>] [[-pushmulticlients] <Boolean>] [[-comment] <Boolean>] [[-mssqlserverversion] <Boolean>]
 [[-oracleserverversion] <Boolean>] [[-rhistate] <Boolean>] [[-dnsrecordtype] <Boolean>]
 [[-persistenceid] <Boolean>] [[-dtls] <Boolean>] [[-persistencetype] <Boolean>] [[-persistmask] <Boolean>]
 [[-v6persistmasklen] <Boolean>] [[-timeout] <Boolean>] [[-cookiename] <Boolean>]
 [[-persistencebackup] <Boolean>] [[-backuppersistencetimeout] <Boolean>]
 [[-probesuccessresponsecode] <Boolean>] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Configuration for CS virtual server resource.

EXAMPLES

EXAMPLE 1

Invoke-ADCUnsetCsvserver -name <string>

An example how to unset csvserver configuration Object(s).

PARAMETERS

-Name

Name for the content switching virtual server. Must begin with an ASCII alphanumeric or underscore (_) character, and must contain only ASCII alphanumeric, underscore, hash (#), period (.), space, colon (:), at sign (@), equal sign (=), and hyphen (-) characters. Cannot be changed after the CS virtual server is created.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-casesensitive

Consider case in URLs (for policies that use URLs instead of RULES). For example, with the ON setting, the URLs /a/1.html and /A/1.HTML are treated differently and can have different targets (set by content switching policies). With the OFF setting, /a/1.html and /A/1.HTML are switched to the same target. Possible values = ON, OFF

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 3
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-backupvserver

Name of the backup virtual server that you are configuring. Must begin with an ASCII alphanumeric or underscore (_) character, and must contain only ASCII alphanumeric, underscore, hash (#), period (.), space, colon (:), at sign (@), equal sign (=), and hyphen (-) characters. Can be changed after the backup virtual server is created. You can assign a different backup virtual server or rename the existing virtual server.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 4
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-clttimeout

Idle time, in seconds, after which the client connection is terminated. The default values are: 180 seconds for HTTP/SSL-based services. 9000 seconds for other TCP-based services. 120 seconds for DNS-based services. 120 seconds for other UDP-based services.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 5
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-redirecturl

URL to which traffic is redirected if the virtual server becomes unavailable. The service type of the virtual server should be either HTTP or SSL. Caution: Make sure that the domain in the URL does not match the domain specified for a content switching policy. If it does, requests are continuously redirected to the unavailable virtual server.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 6
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-authn401

Enable HTTP 401-response based authentication. Possible values = ON, OFF

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 7
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-authentication

Authenticate users who request a connection to the content switching virtual server. Possible values = ON, OFF

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 8
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-authenticationhost

FQDN of the authentication virtual server. The service type of the virtual server should be either HTTP or SSL.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 9
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-authnvsname

Name of authentication virtual server that authenticates the incoming user requests to this content switching virtual server. .

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 10
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-pushvserver

Name of the load balancing virtual server, of type PUSH or SSL_PUSH, to which the server pushes updates received on the client-facing load balancing virtual server.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 11
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-pushlabel

Expression for extracting the label from the response received from server. This string can be either an existing rule name or an inline expression. The service type of the virtual server should be either HTTP or SSL.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 12
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-tcpprofilename

Name of the TCP profile containing TCP configuration settings for the virtual server.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 13
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-httpprofilename

Name of the HTTP profile containing HTTP configuration settings for the virtual server. The service type of the virtual server should be either HTTP or SSL.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 14
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-dbprofilename

Name of the DB profile.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 15
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-l2conn

Use L2 Parameters to identify a connection. Possible values = ON, OFF

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 16
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-mysqlprotocolversion

The protocol version returned by the mysql vserver.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 17
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-mysqlserverversion

The server version string returned by the mysql vserver.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 18
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-mysqlcharacterset

The character set returned by the mysql vserver.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 19
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-mysqlservercapabilities

The server capabilities returned by the mysql vserver.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 20
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-appflowlog

Enable logging appflow flow information. Possible values = ENABLED, DISABLED

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 21
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-netprofile

The name of the network profile.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 22
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-icmpvsrresponse

Can be active or passive. Possible values = PASSIVE, ACTIVE

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 23
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-authnprofile

Name of the authentication profile to be used when authentication is turned on.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 24
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-sothreshold

Depending on the spillover method, the maximum number of connections or the maximum total bandwidth (Kbps) that a virtual server can handle before spillover occurs.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 25
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-dnsprofilename

Name of the DNS profile to be associated with the VServer. DNS profile properties will applied to the transactions processed by a VServer. This parameter is valid only for DNS and DNS-TCP VServers.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 26
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-tcpprobeport

Port number for external TCP probe. NetScaler provides support for external TCP health check of the vserver status over the selected port. This option is only supported for vservers assigned with an IPAddress or ipset.

in CLI is represented as 65535 in NITRO API

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 27
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-probeprotocol

Citrix ADC provides support for external health check of the vserver status. Select HTTP or TCP probes for healthcheck. Possible values = TCP, HTTP

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 28
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-quicprofilename

Name of QUIC profile which will be attached to the Content Switching VServer.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 29
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-redirectfromport

Port number for the virtual server, from which we absorb the traffic for http redirect.

in CLI is represented as 65535 in NITRO API

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 30
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-httpsredirecturl

URL to which all HTTP traffic received on the port specified in the -redirectFromPort parameter is redirected.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 31
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-ipset

The list of IPv4/IPv6 addresses bound to ipset would form a part of listening service on the current cs vserver.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 32
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-stateupdate

Enable state updates for a specific content switching virtual server. By default, the Content Switching virtual server is always UP, regardless of the state of the Load Balancing virtual servers bound to it. This parameter interacts with the global setting as follows: Global Level | Vserver Level | Result ENABLED ENABLED ENABLED ENABLED DISABLED ENABLED DISABLED ENABLED ENABLED DISABLED DISABLED DISABLED If you want to enable state updates for only some content switching virtual servers, be sure to disable the state update parameter. Possible values = ENABLED, DISABLED, UPDATEONBACKENDUPDATE

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 33
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-precedence

Type of precedence to use for both RULE-based and URL-based policies on the content switching virtual server. With the default (RULE) setting, incoming requests are evaluated against the rule-based content switching policies. If none of the rules match, the URL in the request is evaluated against the URL-based content switching policies. Possible values = RULE, URL

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 34
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-cacheable

Use this option to specify whether a virtual server, used for load balancing or content switching, routes requests to the cache redirection virtual server before sending it to the configured servers. Possible values = YES, NO

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 35
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-somethod

Type of spillover used to divert traffic to the backup virtual server when the primary virtual server reaches the spillover threshold. Connection spillover is based on the number of connections. Bandwidth spillover is based on the total Kbps of incoming and outgoing traffic. Possible values = CONNECTION, DYNAMICCONNECTION, BANDWIDTH, HEALTH, NONE

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 36
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-sopersistence

Maintain source-IP based persistence on primary and backup virtual servers. Possible values = ENABLED, DISABLED

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 37
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-sopersistencetimeout

Time-out value, in minutes, for spillover persistence.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 38
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-sobackupaction

Action to be performed if spillover is to take effect, but no backup chain to spillover is usable or exists. Possible values = DROP, ACCEPT, REDIRECT

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 39
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-redirectportrewrite

State of port rewrite while performing HTTP redirect. Possible values = ENABLED, DISABLED

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 40
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-downstateflush

Flush all active transactions associated with a virtual server whose state transitions from UP to DOWN. Do not enable this option for applications that must complete their transactions. Possible values = ENABLED, DISABLED

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 41
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-disableprimaryondown

Continue forwarding the traffic to backup virtual server even after the primary server comes UP from the DOWN state. Possible values = ENABLED, DISABLED

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 42
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-insertvserveripport

Insert the virtual server's VIP address and port number in the request header. Available values function as follows: VIPADDR - Header contains the vserver's IP address and port number without any translation. OFF - The virtual IP and port header insertion option is disabled. V6TOV4MAPPING - Header contains the mapped IPv4 address corresponding to the IPv6 address of the vserver and the port number. An IPv6 address can be mapped to a user-specified IPv4 address using the set ns ip6 command. Possible values = OFF, VIPADDR, V6TOV4MAPPING

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 43
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-vipheader

Name of virtual server IP and port header, for use with the VServer IP Port Insertion parameter.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 44
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-rtspnat

Enable network address translation (NAT) for real-time streaming protocol (RTSP) connections. Possible values = ON, OFF

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 45
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-listenpolicy

String specifying the listen policy for the content switching virtual server. Can be either the name of an existing expression or an in-line expression.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 46
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-listenpriority

Integer specifying the priority of the listen policy. A higher number specifies a lower priority. If a request matches the listen policies of more than one virtual server the virtual server whose listen policy has the highest priority (the lowest priority number) accepts the request.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 47
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-push

Process traffic with the push virtual server that is bound to this content switching virtual server (specified by the Push VServer parameter). The service type of the push virtual server should be either HTTP or SSL. Possible values = ENABLED, DISABLED

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 48
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-pushmulticlients

Allow multiple Web 2.0 connections from the same client to connect to the virtual server and expect updates. Possible values = YES, NO

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 49
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-comment

Information about this virtual server.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 50
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-mssqlserverversion

The version of the MSSQL server. Possible values = 70, 2000, 2000SP1, 2005, 2008, 2008R2, 2012, 2014

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 51
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-oracleserverversion

Oracle server version. Possible values = 10G, 11G

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 52
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-rhistate

A host route is injected according to the setting on the virtual servers

If set to PASSIVE on all the virtual servers that share the IP address, the appliance always injects the hostroute.
If set to ACTIVE on all the virtual servers that share the IP address, the appliance injects even if one virtual server is UP.
If set to ACTIVE on some virtual servers and PASSIVE on the others, the appliance, injects even if one virtual server set to ACTIVE is UP. Possible values = PASSIVE, ACTIVE

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 53
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-dnsrecordtype

. Possible values = A, AAAA, CNAME, NAPTR

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 54
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-persistenceid

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 55
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-dtls

This option starts/stops the dtls service on the vserver. Possible values = ON, OFF

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 56
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-persistencetype

Type of persistence for the virtual server. Available settings function as follows:

SOURCEIP - Connections from the same client IP address belong to the same persistence session.
COOKIEINSERT - Connections that have the same HTTP Cookie, inserted by a Set-Cookie directive from a server, belong to the same persistence session.
SSLSESSION - Connections that have the same SSL Session ID belong to the same persistence session. Possible values = SOURCEIP, COOKIEINSERT, SSLSESSION, NONE

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 57
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-persistmask

Persistence mask for IP based persistence types, for IPv4 virtual servers.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 58
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-v6persistmasklen

Persistence mask for IP based persistence types, for IPv6 virtual servers.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 59
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-timeout

Time period for which a persistence session is in effect.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 60
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-cookiename

Use this parameter to specify the cookie name for COOKIE peristence type. It specifies the name of cookie with a maximum of 32 characters. If not specified, cookie name is internally generated.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 61
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-persistencebackup

Backup persistence type for the virtual server. Becomes operational if the primary persistence mechanism fails. Possible values = SOURCEIP, NONE

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 62
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-backuppersistencetimeout

Time period for which backup persistence is in effect.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 63
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-probesuccessresponsecode

HTTP code to return in SUCCESS case.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 64
Default value: 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
Parameter Sets: (All)
Aliases: wi

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

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

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

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

NOTES

File Name : Invoke-ADCUnsetCsvserver Version : v2111.2521 Author : John Billekens Reference : https://developer-docs.citrix.com/projects/citrix-adc-nitro-api-reference/en/latest/configuration/cs/csvserver Requires : PowerShell v5.1 and up ADC 13.x and up. ADC 12 and lower may work, not guaranteed.