< Back

Disable-NSservice

Fri Jan 10, 2020 9:44 pm

NAME Disable-NSservice



SYNOPSIS

The disable-NSservice disables a service, or multiple services.





SYNTAX

Disable-NSservice [[-name] <string[]>] [-delay <long>] [-graceful <SwitchParameter>] [-session <nitro_service>]

[-WaitInterval <int>] [-WaitUntilComplete <SwitchParameter>] [<CommonParameters>]





DESCRIPTION

The disable-nsservice disables one or more services. Multiple services can be provided as an array of the names of

the service. With the graceful and waituntilcomplete switch, the command will lock until the services have

transitioned to the "Out of Service" state.





PARAMETERS

-session <nitro_service>

This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and

pipelined into this command.



Required? false

Position? named

Default value

Accept pipeline input? true (ByPropertyName)

Accept wildcard characters? false



-name <string[]>

the name of the service to shutdown. Can be an array



Required? false

Position? 0

Default value

Accept pipeline input? true (ByValue, ByPropertyName)

Accept wildcard characters? false



-graceful <SwitchParameter>

shut down the services gracefully.



Required? false

Position? named

Default value False

Accept pipeline input? true (ByPropertyName)

Accept wildcard characters? false



-delay <long>

Time, in seconds, allocated to the NetScaler appliance for a graceful shutdown of the service. During this

period, new requests are sent to the service only for clients who already have persistent sessions on the

appliance.Requests from new clients are load balanced among other available services.After the delay time

expires, no requests are sent to the service, and the service is marked as unavailable (OUT OF SERVICE).



Required? false

Position? named

Default value 0

Accept pipeline input? true (ByPropertyName)

Accept wildcard characters? false



-WaitUntilComplete <SwitchParameter>

Lock the command until the services have been shutdown. With the verbose switch, the status is shown.



Required? false

Position? named

Default value False

Accept pipeline input? true (ByPropertyName)

Accept wildcard characters? false



-WaitInterval <int>

interval in seconds. When using 'WaitUntilComplete', the command will poll the status of the services, this

interval controls how often.Default is 15 seconds.



Required? false

Position? named

Default value 15

Accept pipeline input? false

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

com.citrix.netscaler.nitro.service.nitro_service

This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and

pipelined into this command.



System.String[]

the name of the service to shutdown. Can be an array



System.Management.Automation.SwitchParameter

shut down the services gracefully.



System.Int64

Time, in seconds, allocated to the NetScaler appliance for a graceful shutdown of the service. During this

period, new requests are sent to the service only for clients who already have persistent sessions on the

appliance.Requests from new clients are load balanced among other available services.After the delay time

expires, no requests are sent to the service, and the service is marked as unavailable (OUT OF SERVICE).



System.Management.Automation.SwitchParameter

Lock the command until the services have been shutdown. With the verbose switch, the status is shown.





OUTPUTS

com.citrix.netscaler.nitro.resource.config.basic.service







RELATED LINKS