au.com.kloud.netscaler.xml
|
<?xml version="1.0"?>
<doc> <assembly> <name>au.com.kloud.netscaler</name> </assembly> <members> <member name="T:au.com.kloud.netscaler.newNSsystemgroup"> <summary> <para type="synopsis">The new-nssystemgroup creates a system group. </para> <para type="description">The new-nssystemgroup creates a system group.</para> </summary> <example> <code>new-nssystemgroup -name "admins"</code> <para>Create a system group called 'admins'</para></example> </member> <member name="F:au.com.kloud.netscaler.newNSsystemgroup.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.newNSsystemgroup.name"> <summary> <para type="description">Specify the name of the group.</para> </summary> </member> <member name="T:au.com.kloud.netscaler.removeNSsystemgroup"> <summary> <para type="synopsis">The remove-nssystemgroup deletes a system group. </para> <para type="description">The remove-nssystemgroup deletes a system group.</para> </summary> <example> <code>remove-nssystemgroup -name "admins"</code> <para>deletes a system group called 'admins'</para></example> </member> <member name="F:au.com.kloud.netscaler.removeNSsystemgroup.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.removeNSsystemgroup.name"> <summary> <para type="description">Specify the name of the group.</para> </summary> </member> <member name="T:au.com.kloud.netscaler.AddNSPolicyToSystemGroup"> <summary> <para type="synopsis">The add-nspolicytosystemgroup binds a command policy to a systemgroup</para> <para type="description">The add-nspolicytosystemgroup binds a command policy to a systemgroup. Use this to assign different permissions such as super user to groups. </para> </summary> <example> <code>add-nspolicytosystemgroup -groupname "admins" -policyname "superuser" -priority 100</code> <para>assigns 'superuser' permissions to group 'admin'</para></example> </member> <member name="F:au.com.kloud.netscaler.AddNSPolicyToSystemGroup.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.AddNSPolicyToSystemGroup.groupname"> <summary> <para type="description">Specify the group to bind the policy to </para> </summary> </member> <member name="F:au.com.kloud.netscaler.AddNSPolicyToSystemGroup.policyname"> <summary> <para type="description">Specify the command policy to bind </para> </summary> </member> <member name="F:au.com.kloud.netscaler.AddNSPolicyToSystemGroup.priority"> <summary> <para type="description">Specify the priority. Defaults to 100 if not specified.</para> </summary> </member> <member name="T:au.com.kloud.netscaler.removeNSPolicyToSystemGroup"> <summary> <para type="synopsis">The remove-nspolicytosystemgroup unbinds a command policy to a systemgroup</para> <para type="description">The remove-nspolicytosystemgroup unbinds a command policy to a systemgroup. Use this to unassign different permissions such as super user to groups. </para> </summary> <example> <code>remove-nspolicytosystemgroup -groupname "admins" -policyname "superuser"</code> <para>removes 'superuser' permissions from group 'admin'</para></example> </member> <member name="F:au.com.kloud.netscaler.removeNSPolicyToSystemGroup.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.removeNSPolicyToSystemGroup.groupname"> <summary> <para type="description">Specify the group name </para> </summary> </member> <member name="F:au.com.kloud.netscaler.removeNSPolicyToSystemGroup.policyname"> <summary> <para type="description">Specify the policy name </para> </summary> </member> <member name="T:au.com.kloud.netscaler.addNSPolicyToGlobal"> <summary> <para type="synopsis">The add-nspolicytoglobal command is used to bind global policies such as authentication policies.</para> <para type="description">Use for global bindings. Doesn't work with syslog policies.</para> </summary> <example><code>add-nspolicytoglobal -policyname "ldap-pol" -priority 100</code> <para>Assign the ldap-pol policy to global</para></example> </member> <member name="F:au.com.kloud.netscaler.addNSPolicyToGlobal.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.addNSPolicyToGlobal.policyname"> <summary> <para type="description">Specify the policy name </para> </summary> </member> <member name="F:au.com.kloud.netscaler.addNSPolicyToGlobal.priority"> <summary> <para type="description">Specify the priority </para> </summary> </member> <member name="F:au.com.kloud.netscaler.addNSPolicyToGlobal.nextfactor"> <summary> <para type="description">Specify the next factor. This is only used for advanced policies.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.addNSPolicyToGlobal.gotopriorityexpression"> <summary> <para type="description">Specify the priority expression </para> </summary> </member> <member name="F:au.com.kloud.netscaler.addNSPolicyToGlobal.globalbindtype"> <summary> <para type="description">Specify the global bind type,. Require for advanced policies. </para> </summary> </member> <member name="T:au.com.kloud.netscaler.removeNSPolicyToGlobal"> <summary> <para type="synopsis">The remove-nspolicytoglobal command is used to unbind global policies such as authentication policies and syslog and nslog policies.</para> <para type="description">Use for global bindings</para> </summary> <example><code>remove-nspolicytoglobal -policyname "ldap-pol"</code> <para>Removes the global binding of the ldap-pol policy.</para></example> </member> <member name="F:au.com.kloud.netscaler.removeNSPolicyToGlobal.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.removeNSPolicyToGlobal.policyname"> <summary> <para type="description">Specify the policy name </para> </summary> </member> <member name="T:au.com.kloud.netscaler.newnshttpProfile"> <summary> <para type="synopsis">The new-nshttprofile command creates an http profile with default settings</para> <para type="description">Use to create a new http profile. Use the get-nshttpprofile and set-nshttpprofile commands to make changes</para> </summary> <example><code>new-nshttprofile -name "httpprofile"</code> <para>Creates an http profile called 'httpprofile'</para></example> </member> <member name="F:au.com.kloud.netscaler.newnshttpProfile.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.newnshttpProfile.name"> <summary> <para type="description">Specify the profile name </para> </summary> </member> <member name="F:au.com.kloud.netscaler.newnshttpProfile.returnobject"> <summary> <para type="description">If set to true, the object that is created is returned. This is useful to testing purposes.</para> </summary> </member> <member name="T:au.com.kloud.netscaler.getnshttpProfile"> <summary> <para type="synopsis">The get-nshttprofile command fetches an http profile and returns it as an object</para> <para type="description">Used to find http profile. Without the name parameter, returns all profiles. </para> </summary> <example><code>get-nshttprofile -name "httpprofile"</code> <para>fetches an http profile called 'httpprofile'</para></example> </member> <member name="F:au.com.kloud.netscaler.getnshttpProfile.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.getnshttpProfile.name"> <summary> <para type="description">Specify the profile name </para> </summary> </member> <member name="T:au.com.kloud.netscaler.setnshttpProfile"> <summary> <para type="synopsis">The set-nshttprofile command updates an existing http profile</para> <para type="description">Update an existing http profile. Fetch the profile with get-nshttpprofile, make changes to the object and re-sumbit using set-nshttpprofile</para> </summary> <example><code>set-nshttprofile -profile $httpprofile</code> <para>update an http profile stored in the $httpprofile variable</para></example> </member> <member name="F:au.com.kloud.netscaler.setnshttpProfile.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.setnshttpProfile.profile"> <summary> <para type="description">Specify the profile name </para> </summary> </member> <member name="F:au.com.kloud.netscaler.setnshttpProfile.returnobject"> <summary> <para type="description">If set to true, the object that is created is returned. This is useful to testing purposes.</para> </summary> </member> <member name="T:au.com.kloud.netscaler.removenshttpProfile"> <summary> <para type="synopsis">The remove-nshttprofile command deletes an existing http profile</para> <para type="description">delete an http profile.</para> </summary> <example><code>remove-nshttprofile -name "httpprofile"</code> <para>Deletes an http profile called "httprofile"</para></example> </member> <member name="F:au.com.kloud.netscaler.removenshttpProfile.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.removenshttpProfile.name"> <summary> <para type="description">Specify the profile name </para> </summary> </member> <member name="T:au.com.kloud.netscaler.newnstcpProfile"> <summary> <para type="synopsis">The new-nstcpprofile command creates an tcp profile with default settings</para> <para type="description">Use to create a new tcp profile. Use the get-nstcpprofile and set-nstcpprofile commands to make changes</para> </summary> <example><code>new-nstcpprofile -name "tcpprofile"</code> <para>Creates a tcp profile called 'tcpprofile'</para></example> </member> <member name="F:au.com.kloud.netscaler.newnstcpProfile.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.newnstcpProfile.name"> <summary> <para type="description">Specify the profile name </para> </summary> </member> <member name="F:au.com.kloud.netscaler.newnstcpProfile.returnobject"> <summary> <para type="description">If set to true, the object that is created is returned. This is useful to testing purposes.</para> </summary> </member> <member name="T:au.com.kloud.netscaler.getnstcpProfile"> <summary> <para type="synopsis">The get-nstcpprofile command fetches an tcp profile and returns it as an object</para> <para type="description">Used to find tcp profile. Without the name parameter, returns all profiles. </para> </summary> <example><code>get-nstcpprofile -name "tcpprofile"</code> <para>fetches a tcp profile called 'tcpprofile'</para></example> </member> <member name="F:au.com.kloud.netscaler.getnstcpProfile.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.getnstcpProfile.name"> <summary> <para type="description">Specify the profile name </para> </summary> </member> <member name="T:au.com.kloud.netscaler.setnstcpProfile"> <summary> <para type="synopsis">The set-nstcpprofile command updates an existing tcp profile</para> <para type="description">Update an existing tcp profile. Fetch the profile with get-nstcpprofile, make changes to the object and re-sumbit using set-nstcpprofile</para> </summary> <example><code>set-nstcpprofile -profile $tcpprofile</code> <para>update an tcp profile stored in the $tcpprofile variable</para></example> </member> <member name="F:au.com.kloud.netscaler.setnstcpProfile.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.setnstcpProfile.profile"> <summary> <para type="description">Specify the profile name </para> </summary> </member> <member name="F:au.com.kloud.netscaler.setnstcpProfile.returnobject"> <summary> <para type="description">If set to true, the object that is created is returned. This is useful to testing purposes.</para> </summary> </member> <member name="T:au.com.kloud.netscaler.removenstcpProfile"> <summary> <para type="synopsis">The remove-nstcpprofile command deletes an existing tcp profile</para> <para type="description">delete a tcp profile.</para> </summary> <example><code>remove-nstcpprofile -name "tcpprofile"</code> <para>Deletes an tcp profile called "tcpprofile"</para></example> </member> <member name="F:au.com.kloud.netscaler.removenstcpProfile.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.removenstcpProfile.name"> <summary> <para type="description">Specify the profile name </para> </summary> </member> <member name="F:au.com.kloud.netscaler.newNSdnsrecord.session"> <summary> <para type="description">This parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.removeNSdnsrecord.session"> <summary> <para type="description">This parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.newNSdnssuffix.session"> <summary> <para type="description">This parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.removeNSdnssuffix.session"> <summary> <para type="description">This parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="T:au.com.kloud.netscaler.pushNSFile"> <summary> <para type="synopsis">Legacy command. Use Add-nsfile instead. The push-NSfile uploads a file to a NetScaler .</para> <para type="description">The push-NSfile cmdlet uploads a file to a NetScaler. It requires a nitro_session object as input, the actual file name, the destination file name and destination path. All parameters are mandatory. </para> </summary> <example> <para>Uploading a certificate</para> <code>$file = (get-content c:\somefile.text" | Out-String )</code> <code>push-NSfile -session $session -sourcefiledata $file -destinationpath "/nsconfig/ssl" -destinationfilename "cert.pem"</code> </example> </member> <member name="F:au.com.kloud.netscaler.pushNSFile.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="P:au.com.kloud.netscaler.pushNSFile.sourcefiledata"> <summary> <para type="description">This specifies the file as a string. Due to a bug in .net, you need to first read the file into a variable. See examples. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.pushNSFile.destinationpath"> <summary> <para type="description">This mandatory parameter specifies the destination path of the file on the NetScaler. Ex "/nsconfig/ssl" </para> </summary> </member> <member name="F:au.com.kloud.netscaler.pushNSFile.destinationfilename"> <summary> <para type="description">This mandatory parameter specifies the filename of the destination file. Ex "cert.pem" </para> </summary> </member> <member name="F:au.com.kloud.netscaler.pushNSFile.pkcs"> <summary> <para type="description">Use when passing PKCS data directly from keyvault. This field takes an array of bytes.</para> </summary> </member> <member name="T:au.com.kloud.netscaler.Resource.Config.Aaa.Binding.addnsbinding"> <summary> <para type="synopsis">The Add-NSpolobjtogroup binds an policy to a aaa group</para> <para type="description">Use this cmdlet to binds policies, bookmarks, intranet IP, intranet applications to aaa groups. AAA groups are used by VPN as well as the AAA functionality. The policy is provided as an object </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Aaa.Binding.addnsbinding.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Aaa.Binding.addnsbinding.onerrorcontinue"> <summary> <para type="description">Specify how to handle errors during bulk imports. The default is to rollback changes (false). Setting this to $true will continue the action.However, no feedback is provided regarding which import failed.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Aaa.Binding.addnsbinding.groupauthpol"> <summary> <para type="description">Provide one ore more (array) objects of type com.citrix.netscaler.nitro.resource.config.aaa.aaagroup_authorizationpolicy_binding</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Aaa.Binding.addnsbinding.userauthpol"> <summary> <para type="description">Provide one ore more (array) objects of type com.citrix.netscaler.nitro.resource.config.aaa.aaauser_authorizationpolicy_binding</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Aaa.Binding.addnsbinding.groupintip"> <summary> <para type="description">Provide one ore more (array) objects of type com.citrix.netscaler.nitro.resource.config.aaa.aaagroup_intranetip_binding</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Aaa.Binding.addnsbinding.userintip"> <summary> <para type="description">Provide one ore more (array) objects of type com.citrix.netscaler.nitro.resource.config.aaa.aaauser_intranetip_binding</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Aaa.Binding.addnsbinding.groupbookmark"> <summary> <para type="description">Provide one ore more (array) objects of type com.citrix.netscaler.nitro.resource.config.aaa.aaagroup_vpnurl_binding</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Aaa.Binding.addnsbinding.userbookmark"> <summary> <para type="description">Provide one ore more (array) objects of type com.citrix.netscaler.nitro.resource.config.aaa.aaauser_vpnurl_binding</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Aaa.Binding.addnsbinding.groupintapp"> <summary> <para type="description">Provide one ore more (array) objects of type com.citrix.netscaler.nitro.resource.config.aaa.aaagroup_vpnintranetapplication_binding</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Aaa.Binding.addnsbinding.userintapp"> <summary> <para type="description">Provide one ore more (array) objects of type com.citrix.netscaler.nitro.resource.config.aaa.aaauser_vpnintranetapplication_binding</para> </summary> </member> <member name="T:au.com.kloud.netscaler.Resource.Config.Aaa.Binding.addnsbulkobject"> <summary> <para type="synopsis">The Add-NSbulkobjects binds bookmarks, policies, intranet applications to groups and vservers. </para> <para type="description">Add objects in bulk. THe objects are to be provided in arrays of PSobjects. Specify the type of object based on the parameter selected. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Aaa.Binding.addnsbulkobject.session"> <summary> <para type="description">This parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Aaa.Binding.addnsbulkobject.onerrorcontinue"> <summary> <para type="description">Specify how to handle errors during bulk imports. The default is to rollback changes (false). Setting this to $true will continue the action.However, no feedback is provided regarding which import failed.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Aaa.Binding.addnsbulkobject.targettype"> <summary> <para type="description">Each PSObject must have a property 'target'. The targettype parameter specifies whether that target is a group or a vpnvserver. Do not provide the name of the group or vserver. that must be provided in the objects.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Aaa.Binding.addnsbulkobject.bookmarkobject"> <summary> <para type="description">Specify a single or array of PSObjects. Required properites are name, target</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Aaa.Binding.addnsbulkobject.intranetappobject"> <summary> <para type="description">Specify a single or array of PSObjects. Required properites are name, target</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Aaa.Binding.addnsbulkobject.policyobject"> <summary> <para type="description">Specify a single or array of PSObjects. Required properites are name (policy name), priority and target. If you are binding an authorization policy, also provide a property called type. Possible values for type are: REQUEST, DNS_REQUEST, ICMP_REQUEST, UDP_REQUEST. </para> </summary> </member> <member name="T:au.com.kloud.netscaler.Resource.Config.Aaa.Binding.addnspolicytogroup"> <summary> <para type="synopsis">The Add-NSpolicytogroup binds an policy to a aaa group</para> <para type="description">Use this cmdlet to binds policies, bookmarks, intranet IP, intranet applications to aaa groups. AAA groups are used by VPN as well as the AAA functionality. </para> </summary> <example> <para>adding a policy</para> <code>add-nspolicytogroup -group "vpnusers" -policyname "proxy-tpol" -priority 100</code> <para>adding an intranet IPs</para> <code>add-nspolicytogroup -group "vpnusers" -network "172.16.0.0" -netmask "255.255.255.0"</code> <para>adding a bookmark</para> <code>add-nspolicytogroup -group "vpnusers" -bookmark "bookmark1"</code> <para>adding an intranet application</para> <code>add-nspolicytogroup -group "vpnusers" -intranetapplication "testapp"</code> </example> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Aaa.Binding.addnspolicytogroup.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Aaa.Binding.addnspolicytogroup.group"> <summary> <para type="description">Specify the group. This is mandatory.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Aaa.Binding.addnspolicytogroup.policyname"> <summary> <para type="description">Specify the policy.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Aaa.Binding.addnspolicytogroup.priority"> <summary> <para type="description">Specify the priority. This is required</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Aaa.Binding.addnspolicytogroup.type"> <summary> <para type="description">Specify the type. This is only used for authorization policies.Possible values = REQUEST, UDP_REQUEST, DNS_REQUEST, ICMP_REQUEST. Only used by NetScalers version 12.0.56.20 and above.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Aaa.Binding.addnspolicytogroup.network"> <summary> <para type="description">Specify the network for the intranet IPs. You must also provide the netmask</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Aaa.Binding.addnspolicytogroup.netmask"> <summary> <para type="description">Specify the netmask for the intranet IPs. You must also provide the network</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Aaa.Binding.addnspolicytogroup.bookmark"> <summary> <para type="description">Specify an existing bookmark using the bookmark name. Note, this does not create the bookmark. This command only binds a bookmark that has already been created.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Aaa.Binding.addnspolicytogroup.intranetapplication"> <summary> <para type="description">Specify the intranet application using the name.</para> </summary> </member> <member name="T:au.com.kloud.netscaler.Resource.Config.Aaa.Binding.removenspolicytogroup"> <summary> <para type="synopsis">The remove-NSpolicytogroup unbinds an policy (or intranet IP, intranet application, bookmark) from a aaa group</para> <para type="description">Use this cmdlet to unbound policies, bookmarks, intranet IP, intranet applications from aaa groups. AAA groups are used by VPN as well as the AAA functionality. </para> </summary> <example> <para>adding a policy</para> <code>remove-nspolicytogroup -group "vpnusers" -policyname "proxy-tpol" -priority 100</code> <para>adding a intranet IPs</para> <code>remove-nspolicytogroup -group "vpnusers" -network "172.16.0.0" -netmask "255.255.255.0"</code> <para>adding a bookmark</para> <code>remove-nspolicytogroup -group "vpnusers" -bookmark "bookmark1"</code> <para>adding an intranet application</para> <code>remove-nspolicytogroup -group "vpnusers" -intranetapplication "testapp"</code> </example> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Aaa.Binding.removenspolicytogroup.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Aaa.Binding.removenspolicytogroup.group"> <summary> <para type="description">Specify the group. This is mandatory.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Aaa.Binding.removenspolicytogroup.policyname"> <summary> <para type="description">Specify the policy.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Aaa.Binding.removenspolicytogroup.type"> <summary> <para type="description">Specify the network for the intranet IPs. You must also provide the netmask</para> </summary> <summary> <para type="description">Specify the type. This is only used for authorization policies.Possible values = REQUEST, UDP_REQUEST, DNS_REQUEST, ICMP_REQUEST. Only used by NetScalers version 12.0.56.20 and above.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Aaa.Binding.removenspolicytogroup.netmask"> <summary> <para type="description">Specify the netmask for the intranet IPs. You must also provide the network</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Aaa.Binding.removenspolicytogroup.bookmark"> <summary> <para type="description">Specify the bookmark using the bookmark name. .</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Aaa.Binding.removenspolicytogroup.intranetapplication"> <summary> <para type="description">Specify the intranet application using the name.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Aaa.Group.getNSgroup.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Aaa.Group.newNSgroup.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Aaa.Group.removeNSgroup.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.AppFlow.Action.getNsAppFlowAction.name"> <summary> <para type="description">Specify the name of the action </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.AppFlow.Action.getNsAppFlowAction.filter"> <summary> <para type="description">provide a filter to search for specific AppFlow action.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.AppFlow.Action.newNsAppFlowAction.Name"> <summary> <para type="description">Specify the name of the action</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.AppFlow.Action.newNsAppFlowAction.Collectors"> <summary> <para type="description">Specify the names of the collectors to use. Array of strings</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.AppFlow.Action.newNsAppFlowAction.clientSideMeasurements"> <summary> <para type="description">On enabling this option, the NetScaler will collect the time required to load and render the mainpage on the client</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.AppFlow.Action.newNsAppFlowAction.PageTracking"> <summary> <para type="description">On enabling this option, the NetScaler will start tracking the page for waterfall chart by inserting a NS_ESNS cookie in the response</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.AppFlow.Action.newNsAppFlowAction.DisableWebInsight"> <summary> <para type="description">On disable this option, the netscaler will not send the webinsight records to the configured collectors. webinsight is enabled by default</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.AppFlow.Action.newNsAppFlowAction.SecurityInSight"> <summary> <para type="description">On enabling this option, the netscaler will send the security insight records to the configured collectors</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.AppFlow.Action.newNsAppFlowAction.DistributionAlgorithm"> <summary> <para type="description">On enabling this option, the netscaler will distribute records among the collectors</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.AppFlow.Action.newNsAppFlowAction.VideoAnalytics"> <summary> <para type="description">On enabling this option, the netscaler will send the videoinsight records to the configured collectors</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.AppFlow.Action.newNsAppFlowAction.comment"> <summary> <para type="description">Specify any comments</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.AppFlow.Action.newNsAppFlowAction.returnobject"> <summary> <para type="description">If set to true, the object that is created is returned. This is useful to testing purposes.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.AppFlow.Action.getNsAppFlowpolicy.name"> <summary> <para type="description">Specify the name of the action </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.AppFlow.Action.getNsAppFlowpolicy.filter"> <summary> <para type="description">provide a filter to search for specific AppFlow action.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.AppFlow.Action.newNsAppFlowPolicy.name"> <summary> <para type="description">Specify the name of the policy</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.AppFlow.Action.newNsAppFlowPolicy.action"> <summary> <para type="description">specify the AppFlow action associated with this policy</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.AppFlow.Action.newNsAppFlowPolicy.undefaction"> <summary> <para type="description">specify the AppFlow action associated an undef event</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.AppFlow.Action.newNsAppFlowPolicy.rule"> <summary> <para type="description">specify the rule for the policy. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.AppFlow.Action.newNsAppFlowPolicy.comment"> <summary> <para type="description">Specify any comments</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.AppFlow.Action.newNsAppFlowPolicy.returnobject"> <summary> <para type="description">If set to true, the object that is created is returned. This is useful to testing purposes.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.AppFlow.Collector.RemoveNSAppFlowAction.Name"> <summary> <para type="description">Specify the name of the collector </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.AppFlow.Collector.RemoveNSAppFlowAction.force"> <summary> <para type="description">If set, force deletion without confirmation.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.AppFlow.Collector.SetNSAppFlowAction.action"> <summary> <para type="description">Specify the name of the collector </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.AppFlow.Collector.SetNSAppFlowAction.returnobject"> <summary> <para type="description">If set to true, the object that is created is returned. This is useful to testing purposes.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.AppFlow.Collector.RemoveNSAppFlowCollector.Name"> <summary> <para type="description">Specify the name of the collector </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.AppFlow.Collector.RemoveNSAppFlowCollector.force"> <summary> <para type="description">If set, force deletion without confirmation.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.AppFlow.Collector.SetNSAppFlowCollector.collector"> <summary> <para type="description">Specify the name of the collector </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.AppFlow.Collector.SetNSAppFlowCollector.returnobject"> <summary> <para type="description">If set to true, the object that is created is returned. This is useful to testing purposes.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.AppFlow.Collector.GetNSAppFlowCollector.name"> <summary> <para type="description">Specify the name of the collector </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.AppFlow.Collector.GetNSAppFlowCollector.filter"> <summary> <para type="description">provide a filter to search for specific AppFlow collectors.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.AppFlow.Collector.newNSAppFlowCollector.name"> <summary> <para type="description">Specify the name of the collector </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.AppFlow.Collector.newNSAppFlowCollector.ipaddress"> <summary> <para type="description">Specify the IPv4 address </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.AppFlow.Collector.newNSAppFlowCollector.port"> <summary> <para type="description">Specify the port used by the collector</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.AppFlow.Collector.newNSAppFlowCollector.transport"> <summary> <para type="description">Specify the transport, either ipfix or logstream. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.AppFlow.Collector.newNSAppFlowCollector.netprofile"> <summary> <para type="description">specify the netprofile.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.AppFlow.Collector.newNSAppFlowCollector.returnobject"> <summary> <para type="description">If set to true, the object that is created is returned. This is useful to testing purposes.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.AppFlow.Collector.RemoveNSAppFlowPolicy.Name"> <summary> <para type="description">Specify the name of the collector </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.AppFlow.Collector.RemoveNSAppFlowPolicy.force"> <summary> <para type="description">If set, force deletion without confirmation.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.AppFlow.Collector.SetNSAppFlowPolicy.policy"> <summary> <para type="description">Specify the name of the collector </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.AppFlow.Collector.SetNSAppFlowPolicy.returnobject"> <summary> <para type="description">If set to true, the object that is created is returned. This is useful to testing purposes.</para> </summary> </member> <member name="T:au.com.kloud.netscaler.Resource.Config.AppFlow.getNsAppFlowParam"> <summary> <para type="synopsis">The get-nsappflowparam returns an object containing the appflow parameters. You can change these and submit the update with the set-nsappflowparam command.</para> <para type="description">Use to fetch all the current app flow parameters.</para> </summary> </member> <member name="T:au.com.kloud.netscaler.Resource.Config.AppFlow.setNsAppFlowParam"> <summary> <para type="synopsis">The set-nsappflowparam updates the App Flow parameters (global settings). This command takes as input an object with the parameters are generated by the get-nsappflowparam command. </para> <para type="description">Use to fetch all the current app flow parameters.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Audit.Action.getNSsyslogaction.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Audit.Action.newNSsyslogaction.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Audit.Action.newNSsyslogaction.returnobject"> <summary> <para type="description">If set to true, the object that is created is returned. This is useful to testing purposes.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Audit.Action.removeNSsyslogaction.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Audit.Action.setNSsyslogaction.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Audit.Action.setNSsyslogaction.returnobject"> <summary> <para type="description">If set to true, the object that is created is returned. This is useful to testing purposes.</para> </summary> </member> <member name="T:au.com.kloud.netscaler.Resource.Config.Audit.Binding.addNSSyslogPolicyToGlobal"> <summary> <para type="synopsis">The add-nssyslogpolicytoglobal command is used to bind global policies such as authentication policies.</para> <para type="description">Use for global bindings.</para> </summary> <example><code>add-nspolicytoglobal -policyname "ldap-pol" -priority 100</code> <para>Assign the ldap-pol policy to global</para></example> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Audit.Binding.addNSSyslogPolicyToGlobal.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Audit.Binding.addNSSyslogPolicyToGlobal.policyname"> <summary> <para type="description">Specify the policy name </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Audit.Binding.addNSSyslogPolicyToGlobal.priority"> <summary> <para type="description">Specify the priority </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Audit.Binding.addNSSyslogPolicyToGlobal.globalbindtype"> <summary> <para type="description">Specify the global bind type,. Require for advanced policies. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Audit.Policy.getNSsyslogpolicy.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Audit.Policy.getNSsyslogpolicy.returnobject"> <summary> <para type="description">If set to true, the object that is created is returned. This is useful to testing purposes.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Audit.Policy.newNSsyslogpolicy.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Audit.Policy.newNSsyslogpolicy.returnobject"> <summary> <para type="description">If set to true, the object that is created is returned. This is useful to testing purposes.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Audit.Policy.removeNSsyslogpolicy.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Audit.Policy.setNSsyslogpolicy.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Audit.Policy.setNSsyslogpolicy.returnobject"> <summary> <para type="description">If set to true, the object that is created is returned. This is useful to testing purposes.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Authentication.authenticationprofile.newNSauthnprofile.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Authentication.authenticationprofile.newNSauthnprofile.returnobject"> <summary> <para type="description">If set to true, the object that is created is returned. This is useful to testing purposes.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Authentication.Bindings.addnsauthpolicytolabel.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Authentication.Bindings.addnsauthpolicytolabel.gotopriorityexpression"> <summary> <para type="description">Specify the expression to use to establish if next factor is evaluated. Command values are "NEXT", "END". Default is "NEXT" </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Authentication.Bindings.addnsauthpolicytolabel.nextfactor"> <summary> <para type="description">Specify the next factor policy label.</para> </summary> </member> <member name="T:au.com.kloud.netscaler.Resource.Config.Authentication.Bindings.addNSauthpolicytovserver"> <summary> <para type="synopsis">The Add-NSauthpolicytovserver attaches an authentication policy or login schema to a vserver</para> <para type="description"> </para> </summary> <example> <para>creating an advanced authentication policy</para> <code>new-nsauthpolicytovserver -vserver "AAA-nf-vs" -action "LDAP-apol" -priority 100 </code> </example> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Authentication.Bindings.addNSauthpolicytovserver.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Authentication.Bindings.addNSthemetovserver.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Authentication.Bindings.removeNSauthpolicytovserver.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Authentication.Bindings.removeNSthemetovserver.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Authentication.CertAction.newnscertaction.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="T:au.com.kloud.netscaler.Resource.Config.Authentication.LdapAction.getnsldapserver"> <summary> <para type="synopsis">The get-NSldapserver returns an ldap server configuration.</para> <para type="description">use to fetch details of an ldap server (action). Returns an object. </para> </summary> <example> <code>get-nsldapserver</code> <para>returns all ldap servers.</para> </example> <example> <code>get-nsldapserver -name ldap-srv</code> <para>returns ldap server named ldap-srv</para> </example> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Authentication.LdapAction.getnsldapserver.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Authentication.LdapAction.getnsldapserver.name"> <summary> <para type="description">Specifies the name of the ldap server (ldap action) </para> </summary> </member> <member name="T:au.com.kloud.netscaler.Resource.Config.Authentication.LdapAction.newNSldapServer"> <summary> <para type="synopsis">The new-NSldapserver creates an ldap server configuration.</para> <para type="description">Use to create an ldap server. </para> </summary> <example> <code>new-nsldapserver -session $session -name "LDAP-asrv" -ipaddress "10.5.1.22" -securityType "TLS" -basedn "DC=domain,DC=com" -binddn "admin@domain.com" -password "password" -logonattribute "sAMAccountName" -groupattribute "memberOf" -subattribute "cn" -ssoattribute "UserPrincipalName"</code> <para>creating an ldap authentication server for Active Directory</para> </example> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Authentication.LdapAction.newNSldapServer.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Authentication.LdapAction.newNSldapServer.name"> <summary> <para type="description">Specifies the name of the ldap server (ldap action) </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Authentication.LdapAction.newNSldapServer.ipaddress"> <summary> <para type="description">Specifies the ip address of the ldap server </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Authentication.LdapAction.newNSldapServer.port"> <summary> <para type="description">Specifies the port </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Authentication.LdapAction.newNSldapServer.securitytype"> <summary> <para type="description">Specifies the type of connection to the ldap server. Default is "PLAINTEXT" Possible values = PLAINTEXT, TLS, SSL. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Authentication.LdapAction.newNSldapServer.basedn"> <summary> <para type="description">Specifies the base DN in Active Directory from where searches start. Hence, this specifies the scope. User accounts outside of this cannot authenticate. On the other hand, specify the root of a domain can have a performance impact (for large directories) and potentially be a security risk.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Authentication.LdapAction.newNSldapServer.binddn"> <summary> <para type="description">Specifies the credential used to connect to Active Directory. This is specified as a UPN.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Authentication.LdapAction.newNSldapServer.password"> <summary> <para type="description">Specifies the password</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Authentication.LdapAction.newNSldapServer.logonattribute"> <summary> <para type="description">Specifies logon attribute. Most common is 'sAMAccountName' or 'UserPrincipalName'</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Authentication.LdapAction.newNSldapServer.groupattribute"> <summary> <para type="description">Specifies group membership attribute. Typically "memberOf" for Active Directory</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Authentication.LdapAction.newNSldapServer.subattribute"> <summary> <para type="description">Specifies sub attribute for group membership. Typically "cn"</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Authentication.LdapAction.newNSldapServer.ssoattribute"> <summary> <para type="description">Specifies the attribute used for single sign-on. However, even if SSO is not used, specifying this will ensure that this attribute is retrieved from AD during logon.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Authentication.LdapAction.newNSldapServer.searchfilter"> <summary> <para type="description">Specifies a search filter for LDAP searches</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Authentication.LdapAction.newNSldapServer.authentication"> <summary> <para type="description">Specifies whether this ldap server configuration is used for authentication. If set to DISABLED the searches will do group extraction but not actually perform an authentication challenge. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Authentication.LdapAction.newNSldapServer.returnobject"> <summary> <para type="description">If set to true, the object that is created is returned. This is useful to testing purposes.</para> </summary> </member> <member name="T:au.com.kloud.netscaler.Resource.Config.Authentication.LdapAction.removensldapserver"> <summary> <para type="synopsis">The remove-NSldapserver removes the configuration of an ldap server</para> <para type="description">Use to remove an ldap server (action)</para> </summary> <example> <code>remove-nsldapserver -name "ldap-srv"</code> <para>removes ldap-srv</para> </example> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Authentication.LdapAction.removensldapserver.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Authentication.LdapAction.removensldapserver.name"> <summary> <para type="description">Specify the name of the ldap server (action) to remove.</para> </summary> </member> <member name="T:au.com.kloud.netscaler.Resource.Config.Authentication.LdapAction.setnsldapserver"> <summary> <para type="synopsis">The set-NSldapserver updates the configuration of an ldap server</para> <para type="description">Use it to submit changes to an existing ldap server. Make sure you set the password on the server object before submitting. The ldap server object must first be fetched by get-nsldapserver. </para> </summary> <example> <code>set-nsldapserver -ldapserver $ldap</code> <para>submits $ldap for changes.</para> </example> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Authentication.LdapAction.setnsldapserver.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Authentication.LdapAction.setnsldapserver.ldapserver"> <summary> <para type="description">Specify an ldap server object such as returned by get-nsldapserver. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Authentication.LoginSchemaPolicy.newnsloginschemapolicy.session"> <summary> <para type="description">This parameter uses a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Authentication.LoginSchemaPolicy.newnsloginschemapolicy.returnobject"> <summary> <para type="description">If set to true, the object that is created is returned. This is useful to testing purposes.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Authentication.LoginSchema.newNSloginschema.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Authentication.LoginSchema.newNSloginschema.authenticationschema"> <summary> <para type="description">Specify the name of the login schema file. This is an XML file that must be uploaded to /nsconfig/loginschema </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Authentication.LoginSchema.newNSloginschema.returnobject"> <summary> <para type="description">If set to true, the object that is created is returned. This is useful to testing purposes.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Authentication.OAuthAction.getNSoauthaction.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Authentication.OAuthAction.newnsoauthaction.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Authentication.OAuthAction.setNSoauthaction.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Authentication.PolicyLabel.newnsauthpolicylabel.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Authentication.PolicyLabel.newnsauthpolicylabel.returnobject"> <summary> <para type="description">If set to true, the object that is created is returned. This is useful to testing purposes.</para> </summary> </member> <member name="T:au.com.kloud.netscaler.Resource.Config.Authentication.Policy.getnsauthenticationpolicy"> <summary> <para type="synopsis">The get-NSauthenticaitonpolicy fetches advanced authentication policies.</para> <para type="description">This command works will most of the different type of authentication policies and will establish the type based on the action specified. </para> </summary> <example> <para> fetches an advanced authentication policies</para> <code>get-nsauthenticationpolicy -name "LDAP-apol"</code> </example> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Authentication.Policy.getnsauthenticationpolicy.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="T:au.com.kloud.netscaler.Resource.Config.Authentication.Policy.newnsauthenticationpolicy"> <summary> <para type="synopsis">The new-NSauthenticaitonpolicy creates an advanced authentication policy.</para> <para type="description">This command works will most of the different type of authentication policies and will establish the type based on the action specified. </para> </summary> <example> <para>creating an advanced authentication policy</para> <code>new-nsauthenticationpolicy -session $session -name "LDAP-apol" -action "LDAP-asrv" -rule "true" </code> </example> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Authentication.Policy.newnsauthenticationpolicy.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Authentication.Policy.newnsauthenticationpolicy.action"> <summary> <para type="description">Specify the action, or in case of ldap the server. (created using new-nsldapserver) </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Authentication.Policy.newnsauthenticationpolicy.returnobject"> <summary> <para type="description">If set to true, the object that is updated is returned. This is useful to testing purposes.</para> </summary> </member> <member name="T:au.com.kloud.netscaler.Resource.Config.Authentication.Policy.removensauthenticationpolicy"> <summary> <para type="synopsis">The new-NSauthenticaitonpolicy creates an advanced authentication policy.</para> <para type="description">This command works will most of the different type of authentication policies and will establish the type based on the action specified. </para> </summary> <example> <para>creating an advanced authentication policy</para> <code>new-nsauthenticationpolicy -session $session -name "LDAP-apol" -action "LDAP-asrv" -rule "true" </code> </example> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Authentication.Policy.removensauthenticationpolicy.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Authentication.Policy.removensauthenticationpolicy.force"> <summary> <para type="description">If set, force deletion without confirmation.</para> </summary> </member> <member name="T:au.com.kloud.netscaler.Resource.Config.Authentication.Policy.Setnsauthenticationpolicy"> <summary> <para type="synopsis">The new-NSauthenticaitonpolicy creates an advanced authentication policy.</para> <para type="description">This command works will most of the different type of authentication policies and will establish the type based on the action specified. </para> </summary> <example> <para>creating an advanced authentication policy</para> <code>new-nsauthenticationpolicy -session $session -name "LDAP-apol" -action "LDAP-asrv" -rule "true" </code> </example> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Authentication.Policy.Setnsauthenticationpolicy.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Authentication.Policy.Setnsauthenticationpolicy.returnobject"> <summary> <para type="description">If set to true, the object that is updated is returned. This is useful to testing purposes.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Authentication.RadiusAction.GetNSRadiusaction.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Authentication.RadiusAction.Newnsradiusaction.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Authentication.RadiusAction.Newnsradiusaction.returnobject"> <summary> <para type="description">If set to true, the object that is created is returned. This is useful to testing purposes.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Authentication.RadiusAction.RemoveNSRadiusAction.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Authentication.RadiusAction.RemoveNSRadiusAction.name"> <summary> <para type="description">Provide the name of the action(s) to delete.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Authentication.RadiusAction.RemoveNSRadiusAction.actionobject"> <summary> <para type="description">Provide the action as a object to delete. To get a service object, use the get-nsradiusaction command</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Authentication.RadiusAction.Setnsradiusaction.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Authentication.RadiusAction.Setnsradiusaction.returnobject"> <summary> <para type="description">If set to true, the object that is updated is returned. This is useful to testing purposes.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Authentication.SamlAction.GetNSSamlAction.session"> <summary> <para type="description">This parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="P:au.com.kloud.netscaler.Resource.Config.Authentication.SamlAction.GetNSSamlAction.Name"> <summary> <para type="description">Specify the name of the Saml action</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Authentication.SamlAction.NewNSSamlAction.session"> <summary> <para type="description">This parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="P:au.com.kloud.netscaler.Resource.Config.Authentication.SamlAction.NewNSSamlAction.Name"> <summary> <para type="description">Specify the name of the Saml action</para> </summary> </member> <member name="P:au.com.kloud.netscaler.Resource.Config.Authentication.SamlAction.NewNSSamlAction.Idpcertificate"> <summary> <para type="description">Specify the name of the Idp certificate. Must be uploaded separately</para> </summary> </member> <member name="P:au.com.kloud.netscaler.Resource.Config.Authentication.SamlAction.NewNSSamlAction.RedirectUrl"> <summary> <para type="description">Specify redirect Url</para> </summary> </member> <member name="P:au.com.kloud.netscaler.Resource.Config.Authentication.SamlAction.NewNSSamlAction.LogoutUrl"> <summary> <para type="description">Specify logout Url</para> </summary> </member> <member name="P:au.com.kloud.netscaler.Resource.Config.Authentication.SamlAction.NewNSSamlAction.UserField"> <summary> <para type="description">Saml User ID as given in the SAML assertion</para> </summary> </member> <member name="P:au.com.kloud.netscaler.Resource.Config.Authentication.SamlAction.NewNSSamlAction.signingCertificateName"> <summary> <para type="description">Specify the signing certificate name.</para> </summary> </member> <member name="P:au.com.kloud.netscaler.Resource.Config.Authentication.SamlAction.NewNSSamlAction.IssuerName"> <summary> <para type="description">Name to be used in requests sent from the NetScaler to Idp to unique identify NetScaler </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Authentication.SamlAction.NewNSSamlAction.RejectUnsigned"> <summary> <para type="description">Reject unsigned assertions. ON results is rejection of assertion that is received without signature. STRICT ensures that both response and assertion are signed. OFF allows unsigned assertions. Possible values ON, OFF, STRICT. Default ON </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Authentication.SamlAction.NewNSSamlAction.SamlBinding"> <summary> <para type="description">Specify the transport mechanism for SALM messages. Possible values POST, REDIRECT,ARTIFACT. Default POST</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Authentication.SamlAction.NewNSSamlAction.LogoutBinding"> <summary> <para type="description">Specify the transport mechanism for Saml logout messages. Possible values POST, REDIRECT. Default POST</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Authentication.SamlAction.NewNSSamlAction.TwoFactor"> <summary> <para type="description">enable two factor after SAML. Possible values ON, OFF. Default OFF</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Authentication.SamlAction.NewNSSamlAction.SignatureAlgorithm"> <summary> <para type="description">Algorithm to be used to sign/verify SAML assertions. Possible values RSA-SHA1, RSA-SHA256. Default RSA-SHA1</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Authentication.SamlAction.NewNSSamlAction.DigestMethod"> <summary> <para type="description">Algorithm to be used to compute/verify digest for SAML transactions. Possible values SHA1, SHA256, Default SHA1</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Authentication.SamlAction.NewNSSamlAction.returnobject"> <summary> <para type="description">If set to true, the object that is updated is returned. This is useful to testing purposes.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Authentication.SamlAction.RemoveNSSamlAction.session"> <summary> <para type="description">This parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="P:au.com.kloud.netscaler.Resource.Config.Authentication.SamlAction.RemoveNSSamlAction.Name"> <summary> <para type="description">Specify the name of the Saml action</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Authentication.SamlAction.SetNSSamlAction.session"> <summary> <para type="description">This parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="P:au.com.kloud.netscaler.Resource.Config.Authentication.SamlAction.SetNSSamlAction.actionobject"> <summary> <para type="description">provide the saml action to update. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Authentication.SamlAction.SetNSSamlAction.returnobject"> <summary> <para type="description">If set to true, the object that is updated is returned. This is useful to testing purposes.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Authentication.SamlPolicy.NewNsSamlPolicy.session"> <summary> <para type="description">This parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="P:au.com.kloud.netscaler.Resource.Config.Authentication.SamlPolicy.NewNsSamlPolicy.Name"> <summary> <para type="description">Specify the name of the Saml action</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Authentication.SamlPolicy.NewNsSamlPolicy.returnobject"> <summary> <para type="description">If set to true, the object that is updated is returned. This is useful to testing purposes.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Authentication.SamlPolicy.removeNsSamlPolicy.session"> <summary> <para type="description">This parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="P:au.com.kloud.netscaler.Resource.Config.Authentication.SamlPolicy.removeNsSamlPolicy.Name"> <summary> <para type="description">Specify the name of the Saml policy</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Authentication.SamlPolicy.removeNsSamlPolicy.force"> <summary> <para type="description">If set, force deletion without confirmation.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Authentication.Vserver.GetNSaaavserver.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Authentication.Vserver.Newnsaaavserver.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Authentication.Vserver.Newnsaaavserver.returnobject"> <summary> <para type="description">If set to true, the object that is created is returned. This is useful to testing purposes.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Authentication.Vserver.RemoveNsAAAVserver.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Authentication.Vserver.RemoveNsAAAVserver.name"> <summary> <para type="description">Provide the name of the AAA vserver(s) to delete.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Authentication.Vserver.RemoveNsAAAVserver.serverobject"> <summary> <para type="description">Provide the vserver as a object to delete. To get a vserver object, use the get-nsaaavserver command</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Authentication.Vserver.setNSaaavserver.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Authentication.Vserver.setNSaaavserver.returnobject"> <summary> <para type="description">If set to true, the object that is created is returned. This is useful to testing purposes.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Authorization.Policy.getnsauthorizationpolicy.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Authorization.Policy.newnsauthorizationpolicy.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Authorization.Policy.newnsauthorizationpolicy.policyobject"> <summary> <para type="description">The policyobject allows for a single or array of PSObjects. The PSObject must have a name, action and rule property. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Authorization.Policy.newnsauthorizationpolicy.onerrorcontinue"> <summary> <para type="description">Specify whether the bulk submission should continue (true) in case of error, or rollback the changes (false) </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Authorization.Policy.newnsauthorizationpolicy.policy"> <summary> <para type="description">Use the policy parameter to create an authorization policy by feeding in one or more authorization policy object of type com.citrix.netscaler.nitro.resource.config.authorization.authorizationpolicy </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Authorization.Policy.newnsauthorizationpolicy.returnobject"> <summary> <para type="description">If set to true, the object that is created is returned. This is useful to testing purposes.</para> </summary> </member> <member name="T:au.com.kloud.netscaler.Resource.Config.Basic.Servers.getnsserver"> <summary> <para type="synopsis">The get-nsserver fetches one or more servers.</para> <para type="description">The get-nsserver fetches one or more servers. The result is one or more server objects.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Basic.Servers.getnsserver.name"> <summary> <para type="description">Specify the name, to return details of a specific server. All servers are returned if this is left blank.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Basic.Servers.getnsserver.filter"> <summary> <para type="description">Optional parameter to provide a filter to be used during search. Format "property:value,property:value" ex "ip:10.12.45.6" Note, because of a bug in the API, when searching based on an IP address, server using a hostname are also returned. Use the following filter to search just based on IP "ipaddress:x.x.x.x,domain:null"</para> </summary> </member> <member name="T:au.com.kloud.netscaler.Resource.Config.Basic.Server.newNSserver"> <summary> <para type="synopsis">The new-nsserver command creates a server object in the netscaler.</para> <para type="description">The new-nsserver command is used to create new server object in the netscaler. Currently the command requires a nitro session object, as well as name and ip address. Other parameters are optional. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Basic.Server.newNSserver.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Basic.Server.newNSserver.name"> <summary> <para type="description"> Specify the name of the server object. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Basic.Server.newNSserver.comment"> <summary> <para type="description">Specify any comment you want to store with the object. Optional. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Basic.Server.newNSserver.ipaddress"> <summary> <para type="description">This mandatory parameter specifies the IP address of the server. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Basic.Server.newNSserver.state"> <summary> <para type="description">This parameter can be used to set the state of the server. Default is "ENABLED". Specify "DISABLED" to create server that is disabled. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Basic.Server.newNSserver.returnobject"> <summary> <para type="description">If set to true, the object that is created is returned. This is useful to testing purposes.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Basic.Server.removensserver.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Basic.Server.removensserver.name"> <summary> <para type="description"> Specify the name of the server object. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Basic.Server.removensserver.serverobject"> <summary> <para type="description"> Specify the server object. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Basic.Server.setNSserver.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Basic.Server.setNSserver.state"> <summary> <para type="description">Use the state parameter to enable or disable a service. Value is either 'ENABLED' or 'DISABLED' </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Basic.Server.setNSserver.returnobject"> <summary> <para type="description">If set to true, the object that is updated is returned. This is useful to testing purposes.</para> </summary> </member> <member name="T:au.com.kloud.netscaler.Resource.Config.Basic.GetNSServiceGroup"> <summary> <para type="synopsis">The get-nsservicegroup command return a service group object in the netscaler.</para> <para type="description">The get-nsservicegroup command is used to get new service group objects </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Basic.GetNSServiceGroup.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Basic.GetNSServiceGroup.name"> <summary> <para type="description"> Specify the name of the server object. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Basic.GetNSServiceGroup.filter"> <summary> <para type="description">Search based on filter. The format of the filter is a json value pair. Ex: "{'autoscale':'ENABLED'}" will return all services groups with autoscale set to enabled. The filter must be enclosed in quotes. </para> </summary> </member> <member name="T:au.com.kloud.netscaler.Resource.Config.Basic.NewNSServiceGroup"> <summary> <para type="synopsis">The new-nsservicegroup command creates a service group object in the netscaler.</para> <para type="description">The new-nsservicegroup command is used to create new service group object in the netscaler.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Basic.NewNSServiceGroup.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Basic.NewNSServiceGroup.name"> <summary> <para type="description"> Specify the name of the server object. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Basic.NewNSServiceGroup.type"> <summary> <para type="description">Specify the service type for the group. Possible values are: HTTP, FTP, TCP, UDP, SSL, SSL_BRIDGE, SSL_TCP, DTLS, NNTP, RPCSVR, DNS, ADNS, SNMP, RTSP, DHCPRA, ANY, SIP_UDP, SIP_TCP, SIP_SSL, DNS_TCP, ADNS_TCP, MYSQL, MSSQL, ORACLE, RADIUS, RADIUSListener, RDP, DIAMETER, SSL_DIAMETER, TFTP, SMPP, PPTP, GRE, SYSLOGTCP, SYSLOGUDP, FIX, SSL_FIX, USER_TCP, USER_SSL_TCP, QUIC </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Basic.NewNSServiceGroup.healthmonitor"> <summary> <para type="description">Specify if healthmonitoring should be enabled. Default is yes. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Basic.NewNSServiceGroup.useproxyport"> <summary> <para type="description">With the NO setting, the client-side connection port is used as the source port for the server-side connection. Note: This parameter is available only when the Use Source IP(USIP) parameter is set to YES. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Basic.NewNSServiceGroup.clientkeepalives"> <summary> <para type="description">Enable client keep alives. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Basic.NewNSServiceGroup.header"> <summary> <para type="description">Client header. Only used if clientip is set to ENABLED </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Basic.NewNSServiceGroup.comment"> <summary> <para type="description">Specify any comment you want to store with the object. Optional. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Basic.NewNSServiceGroup.returnobject"> <summary> <para type="description">If set to true, the object that is created is returned. This is useful to testing purposes.</para> </summary> </member> <member name="T:au.com.kloud.netscaler.Resource.Config.Basic.setNSServiceGroup"> <summary> <para type="synopsis">The set-nsservicegroup command sets new values on a service group object.</para> <para type="description">The set-nsservicegroup command is used to update a service group using a service group object. First create a service group object (through get-nsservicegroup), change whatever value you need, and than apply the changes using this command.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Basic.setNSServiceGroup.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Basic.setNSServiceGroup.groupobject"> <summary> <para type="description"> provide the service group object to update. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Basic.setNSServiceGroup.returnobject"> <summary> <para type="description">If set to true, the object that is updated is returned. This is useful to testing purposes.</para> </summary> </member> <member name="T:au.com.kloud.netscaler.Resource.Config.Basic.removeNSServiceGroup"> <summary> <para type="synopsis">The remove-nsservicegroup command removes a service group object.</para> <para type="description">The remove-nsservicegroup command is used to remove a service group</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Basic.removeNSServiceGroup.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Basic.removeNSServiceGroup.name"> <summary> <para type="description"> provide the service group name to delete.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Basic.removeNSServiceGroup.groupobject"> <summary> <para type="description"> provide the service group object to delete. Useful if pipelining this from a get-nsservicegroup command. </para> </summary> </member> <member name="T:au.com.kloud.netscaler.Resource.Config.Basic.DisableNSservice"> <summary> <para type="synopsis">The disable-NSservice disables a service, or multiple services.</para> <para type="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. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Basic.DisableNSservice.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Basic.DisableNSservice.name"> <summary> <para type="description">the name of the service to shutdown. Can be an array</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Basic.DisableNSservice.graceful"> <summary> <para type="description">shut down the services gracefully.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Basic.DisableNSservice.delay"> <summary> <para type="description">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).</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Basic.DisableNSservice.WaitUntilComplete"> <summary> <para type="description">Lock the command until the services have been shutdown. With the verbose switch, the status is shown.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Basic.DisableNSservice.WaitInterval"> <summary> <para type="description">interval in seconds. When using 'WaitUntilComplete', the command will poll the status of the services, this interval controls how often.Default is 15 seconds.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Basic.EnableNSvservice.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Basic.EnableNSvservice.WaitUntilComplete"> <summary> <para type="description">Lock the command until the services have been started. With the verbose switch, the progress is shown.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Basic.EnableNSvservice.WaitInterval"> <summary> <para type="description">interval in seconds. When using 'WaitUntilComplete', the command will poll the status of the services, this interval controls how often.Default is 15 seconds.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Basic.EnableNSvservice.maxWaitUntilComplete"> <summary> <para type="description">maximum runtime for this command, in seconds. Once this expires, the command will error out. this is mainly intended to be used with "waituntilcomplete" to avoid the command never completing.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Basic.getNSservice.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="T:au.com.kloud.netscaler.Resource.Config.Basic.newNSservice"> <summary> <para type="synopsis">The new-NSservice creates a new service on the netscaler.</para> <para type="description">Use the new-NSservice cmdlet to create a new service on the netscaler. Either specify the servername (server hosting the service) or IP address of the server (which will create a matching server configuration).</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Basic.newNSservice.session"> <summary> <para type="description">This parameter specifies a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Basic.newNSservice.name"> <summary> <para type="description">Specify the name of the service. This has to be unique and can be used to search for the service, or bind it. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Basic.newNSservice.comment"> <summary> <para type="description">Optional comment </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Basic.newNSservice.ip"> <summary> <para type="description">Specify the IP address of the server associated with this service. You have to specify either the IP or the servername property. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Basic.newNSservice.servername"> <summary> <para type="description">Specify the server name (name of the server object in NetScaler) of the server associated with this service. You have to specify either the IP or the servername property. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Basic.newNSservice.monitor"> <summary> <para type="description">Specify the name of a monitor to bind it to the service during creation.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Basic.newNSservice.port"> <summary> <para type="description">Specify the port the destination server is listening on. Required.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Basic.newNSservice.servicetype"> <summary> <para type="description">Specify the service type. Required. Possible values = HTTP, FTP, TCP, UDP, SSL, SSL_BRIDGE, SSL_TCP, DTLS, NNTP, RPCSVR, DNS, ADNS, SNMP, RTSP, DHCPRA, ANY, SIP_UDP, SIP_TCP, SIP_SSL, DNS_TCP, ADNS_TCP, MYSQL, MSSQL, ORACLE, RADIUS, RADIUSListener, RDP, DIAMETER, SSL_DIAMETER, TFTP, SMPP, PPTP, GRE, SYSLOGTCP, SYSLOGUDP, FIX, SSL_FIX, USER_TCP, USER_SSL_TCP .</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Basic.newNSservice.state"> <summary> <para type="description">Specify the state of the service. Default is "ENABLED". </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Basic.newNSservice.returnobject"> <summary> <para type="description">If set to true, the object that is created is returned. This is useful to testing purposes.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Basic.RemoveNSservice.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Basic.RemoveNSservice.name"> <summary> <para type="description">Provide the name of the service to delete.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Basic.RemoveNSservice.serviceobject"> <summary> <para type="description">Provide the service as a service object to delete. To get a service object, use the get-nsservice command</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Basic.setNSserver.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Basic.setNSserver.returnobject"> <summary> <para type="description">If set to true, the object that is created is returned. This is useful to testing purposes.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Vpn.addnsStatoVserver.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Vpn.removensStatoVserver.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Vpn.VpnParameter.getNSvpnglobalsettings.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Vpn.VpnParameter.setNSvpnglobalsettings.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Vpn.VpnParameter.setNSvpnglobalsettings.returnobject"> <summary> <para type="description">If set to true, the object that is created is returned. This is useful to testing purposes.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Vpn.VpnServer.getNSvpnvserver.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Vpn.VpnServer.newNSvpnvserver.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Vpn.VpnServer.newNSvpnvserver.returnobject"> <summary> <para type="description">If set to true, the object that is created is returned. This is useful to testing purposes.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Vpn.VpnServer.removeNSvpnvserver.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Vpn.VpnServer.removeNSvpnvserver.force"> <summary> <para type="description">If set, force deletion without confirmation.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Vpn.VpnServer.setNSvpnvserver.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Vpn.VpnServer.setNSvpnvserver.returnobject"> <summary> <para type="description">If set to true, the object that is created is returned. This is useful to testing purposes.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Vpn.VpnSessionAction.getNSsessionprofile.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Vpn.VpnSessionAction.newNSsessionprofile.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Vpn.VpnSessionAction.newNSsessionprofile.returnobject"> <summary> <para type="description">If set to true, the object that is created is returned. This is useful to testing purposes.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Vpn.VpnSessionAction.RemoveNSsessionprofile.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Vpn.VpnSessionAction.setNSsessionprofile.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Vpn.VpnSessionAction.setNSsessionprofile.returnobject"> <summary> <para type="description">If set to true, the object that is created is returned. This is useful to testing purposes.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Vpn.VpnSessionPolicy.getNSsessionpolicy.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Vpn.VpnSessionPolicy.newNSsessionpolicy.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Vpn.VpnSessionPolicy.newNSsessionpolicy.returnobject"> <summary> <para type="description">If set to true, the object that is created is returned. This is useful to testing purposes.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Vpn.VpnSessionPolicy.setNSsessionpolicy.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="T:au.com.kloud.netscaler.Resource.Config.Dns.DnsNameServer.getNSnameserver"> <summary> <para type="synopsis">The get-nsnameserver returns the nameservers</para> <para type="description">use get-nsnameserver search for nameservers</para> </summary> <example> <code>get-nsnameserver</code> <para>returns all nameserver</para> </example> <example> <code>get-nsnameserver -filter "ip:10.123.45.6"</code> <para>returns name server object for 10.123.45.6</para> </example> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Dns.DnsNameServer.getNSnameserver.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Dns.DnsNameServer.getNSnameserver.filter"> <summary> <para type="description">Optional parameter to provide a filter to be used during search. Format "property:value,property:value" ex "ip:10.12.45.6"</para> </summary> </member> <member name="T:au.com.kloud.netscaler.Resource.Config.Dns.DnsNameServer.newNSnameserver"> <summary> <para type="synopsis">The new-nsnameserver sets the nameserver</para> <para type="description">use new-nsnameserver to set the initial nameserver</para> </summary> <example> <code>new-nsnameserver -dnsvserveranem "dns-lb"</code> <para>set the dns-lb load balancer as the DNS server</para> </example> <example> <code>new-nsnameserver -ip "10.123.45.6" -type "UDP" -returnobject $true</code> <para>set 10.123.45.6 as a DNS server, use UDP and output the name server object.</para> </example> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Dns.DnsNameServer.newNSnameserver.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Dns.DnsNameServer.newNSnameserver.dnsvservername"> <summary> <para type="description">Specify a DNS LB vserver. If using this, don't specify the IP address parameter. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Dns.DnsNameServer.newNSnameserver.ip"> <summary> <para type="description">Specify the IP address of the DNS server. Do not specify the dnsvservername parameter if using the IP address.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Dns.DnsNameServer.newNSnameserver.local"> <summary> <para type="description">Specify if the IP address refers to an IP address owned by the NetScaler that can do recursive lookups. Not used with the dnsvservername parameter. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Dns.DnsNameServer.newNSnameserver.type"> <summary> <para type="description">type, typically UDP </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Dns.DnsNameServer.newNSnameserver.dnsprofilename"> <summary> <para type="description">specify a DNS profile if required </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Dns.DnsNameServer.newNSnameserver.returnobject"> <summary> <para type="description">If set to true, the object that is created is returned. This is useful to testing purposes.</para> </summary> </member> <member name="T:au.com.kloud.netscaler.Resource.Config.Dns.DnsNameServer.removeNSnameserver"> <summary> <para type="synopsis">The remove-nsnameserver removes a the nameservers</para> <para type="description">use remove-nsnameserver removes for nameservers</para> </summary> <example> <code>remove-nsnameserver -ip "10.123.45.6"</code> <para>remove nameserver 10.123.45.6</para> </example> <example> <code>remove-nsnameserver -nameserver $server</code> <para>remove nameserver specified by the $server object</para> </example> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Dns.DnsNameServer.removeNSnameserver.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Dns.DnsNameServer.removeNSnameserver.ip"> <summary> <para type="description">Specify the IP address of the name server to remove.</para> </summary> </member> <member name="P:au.com.kloud.netscaler.Resource.Config.Dns.DnsNameServer.removeNSnameserver.nameserver"> <summary> <para type="description">Specify a dns name server object as returned by get-nsnameserver.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Dns.Dnszone.removeNsDnszone.session"> <summary> <para type="description">This parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Dns.Dnszone.removeNsDnszone.zonename"> <summary> <para type="description">Specify the name of the zone.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Dns.Dnszone.removeNsDnszone.force"> <summary> <para type="description">If set, force deletion without confirmation.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Dns.Dnszone.newNsDnszone.session"> <summary> <para type="description">This parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Dns.Dnszone.newNsDnszone.zonename"> <summary> <para type="description">Specify the name of the zone.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Dns.Dnszone.newNsDnszone.proxy"> <summary> <para type="description">enable this to set the zone to proxy mode YES. Default is NO.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Dns.Dnszone.newNsDnszone.returnobject"> <summary> <para type="description">If set to true, the object that is created is returned. This is useful to testing purposes.</para> </summary> </member> <member name="T:au.com.kloud.netscaler.Resource.Config.Lb.Bindings.removeNSpolicyToVserver"> <summary> <para type="synopsis">The add-nspolicytovserver cmdlet is used to associate a policy with a vserver.</para> <para type="description">The add-nspolicytovserver cmdlet is used to associate a policy with a vserver.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Lb.Bindings.removeNSpolicyToVserver.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Lb.Bindings.removeNSpolicyToVserver.policyname"> <summary> <para type="description">Specify the name of the monitor </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Lb.Bindings.removeNSpolicyToVserver.vserver"> <summary> <para type="description">Specify the name the service or service group to bind to </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Lb.Bindings.removeNSpolicyToVserver.policytype"> <summary> <para type="description">Policy type.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Lb.Bindings.removeNSpolicyToVserver.bindpoint"> <summary> <para type="description">Specify the bindpoint of the binding. Required for rewrite, appflow policies</para> </summary> </member> <member name="T:au.com.kloud.netscaler.Resource.Config.Lb.Bindings.addNSpolicyToVserver"> <summary> <para type="synopsis">The add-nspolicytovserver cmdlet is used to associate a policy with a vserver. Currently only for rewrite, responder and appflow policies.</para> <para type="description">The add-nspolicytovserver cmdlet is used to associate a policy with a vserver.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Lb.Bindings.addNSpolicyToVserver.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Lb.Bindings.addNSpolicyToVserver.policyname"> <summary> <para type="description">Specify the name of the monitor </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Lb.Bindings.addNSpolicyToVserver.vserver"> <summary> <para type="description">Specify the name the service or service group to bind to </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Lb.Bindings.addNSpolicyToVserver.priority"> <summary> <para type="description">Specify the weight of the binding. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Lb.Bindings.addNSpolicyToVserver.bindpoint"> <summary> <para type="description">Specify the bindpoint of the binding. Required for rewrite policies. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Lb.Bindings.addNSpolicyToVserver.policytype"> <summary> <para type="description">Policy type.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Lb.Bindings.addNSpolicyToVserver.gotopriorityExpression"> <summary> <para type="description">Expression specifying the priority of the next policy which will get evaluated if the current policy rule evaluates to TRUE. Common values are "END", "NEXT", but can be a NetScaler expression. Defaults to "END" </para> </summary> </member> <member name="T:au.com.kloud.netscaler.Resource.Config.Lb.Bindings.addNSmonitorToService"> <summary> <para type="synopsis">The add-nsmonitortoservice cmdlet is used to associate a monitor with a service or service group. </para> <para type="description">The add-nsmonitortoservice cmdlet is used to associate a monitor with a service or service group. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Lb.Bindings.addNSmonitorToService.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Lb.Bindings.addNSmonitorToService.monitorname"> <summary> <para type="description">Specify the name of the monitor </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Lb.Bindings.addNSmonitorToService.servicename"> <summary> <para type="description">Specify the name the service or service group to bind to </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Lb.Bindings.addNSmonitorToService.weight"> <summary> <para type="description">Specify the weight of the binding. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Lb.Bindings.addNSmonitorToService.returnobject"> <summary> <para type="description">If set to true, the object that is created is returned. This is useful to testing purposes.</para> </summary> </member> <member name="T:au.com.kloud.netscaler.Resource.Config.Lb.Bindings.addNSresponderpolicyTovServer"> <summary> <para type="synopsis">The add-NSresponderpolicyTovserver binds a responderpolicy to a vserver. Requires the vserver name and the responder policy name. </para> <para type="description">The add-NSresponderpolicyTovserver binds a responderpolicy to a vserver. Requires the vserver name and the responder policy name. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Lb.Bindings.addNSresponderpolicyTovServer.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Lb.Bindings.addNSresponderpolicyTovServer.policy"> <summary> <para type="description">Specify the name of the responderpolicy to bind. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Lb.Bindings.addNSresponderpolicyTovServer.vserver"> <summary> <para type="description">Specify the name of the vserver to bind to.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Lb.Bindings.addNSresponderpolicyTovServer.priority"> <summary> <para type="description">Specify the priority6 for the binding. Default is 100. this is optional. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Lb.Bindings.addnsservertoServiceGroup.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Lb.Bindings.addnsservertoServiceGroup.servicegroup"> <summary> <para type="description">Specify the name of the service group </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Lb.Bindings.addnsservertoServiceGroup.server"> <summary> <para type="description">Specify the name the server, use instead of the IP address </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Lb.Bindings.addnsservertoServiceGroup.ip"> <summary> <para type="description">Specify the IP address. Use instead of the server name. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Lb.Bindings.addnsservertoServiceGroup.port"> <summary> <para type="description">Specify the port</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Lb.Bindings.addnsservertoServiceGroup.serverid"> <summary> <para type="description">Specify the server id. optional </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Lb.Bindings.addnsservertoServiceGroup.weight"> <summary> <para type="description">Specify the weight of the binding. default is 1 </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Lb.Bindings.addnsservertoServiceGroup.returnobject"> <summary> <para type="description">If set to true, the object that is created is returned. This is useful to testing purposes.</para> </summary> </member> <member name="T:au.com.kloud.netscaler.Resource.Config.Lb.Bindings.addNSserviceTovServer"> <summary> <para type="synopsis">The add-NSserviceTovserver binds a service to a vserver. Requires the vserver name and the service name. </para> <para type="description">The add-NSserviceTovserver binds a service to a vserver. Requires the vserver name and the service name. Optionally, weight can be specified. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Lb.Bindings.addNSserviceTovServer.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Lb.Bindings.addNSserviceTovServer.servicename"> <summary> <para type="description">Specify the name of the service to bind. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Lb.Bindings.addNSserviceTovServer.vserver"> <summary> <para type="description">Specify the name of the vserver to bind to.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Lb.Bindings.addNSserviceTovServer.weight"> <summary> <para type="description">Specify the weight for the binding. Default is 1. this is optional. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Lb.Bindings.addNSserviceTovServer.returnobject"> <summary> <para type="description">If set to true, the object that is created is returned. This is useful to testing purposes.</para> </summary> </member> <member name="T:au.com.kloud.netscaler.Resource.Config.Lb.Bindings.removeNSmonitorToService"> <summary> <para type="synopsis">The remove-nsmonitortoservice cmdlet is used to disassociate a monitor from a service or service group. </para> <para type="description">The remove-nsmonitortoservice cmdlet is used to disassociate a monitor from a service or service group. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Lb.Bindings.removeNSmonitorToService.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Lb.Bindings.removeNSmonitorToService.monitorname"> <summary> <para type="description">Specify the name of the monitor </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Lb.Bindings.removeNSmonitorToService.servicename"> <summary> <para type="description">Specify the name the service or service group to unbind from </para> </summary> </member> <member name="T:au.com.kloud.netscaler.Resource.Config.Lb.Bindings.removeNSresponderpolicyTovServer"> <summary> <para type="synopsis">The remove-NSresponderpolicyTovserver removes a responderpolicy from a vserver. Requires the vserver name and the responder policy name. </para> <para type="description">The remove-NSresponderpolicyTovserver removes a responderpolicy from a vserver. Requires the vserver name and the responder policy name. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Lb.Bindings.removeNSresponderpolicyTovServer.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Lb.Bindings.removeNSresponderpolicyTovServer.policy"> <summary> <para type="description">Specify the name of the responderpolicy to bind. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Lb.Bindings.removeNSresponderpolicyTovServer.vserver"> <summary> <para type="description">Specify the name of the vserver to bind to.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Lb.Bindings.removeNSresponderpolicyTovServer.force"> <summary> <para type="description">If set, force deletion without confirmation.</para> </summary> </member> <member name="T:au.com.kloud.netscaler.Resource.Config.Lb.Bindings.removeNSserverToServiceGroup"> <summary> <para type="synopsis">The remove-nsservertoservicegroup cmdlet is used to disassociate a server from a service group. </para> <para type="description">The remove-nsservertoservicegroup cmdlet is used to disassociate a server from a service group. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Lb.Bindings.removeNSserverToServiceGroup.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Lb.Bindings.removeNSserverToServiceGroup.servicegroup"> <summary> <para type="description">Specify the name of the servicegroup </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Lb.Bindings.removeNSserverToServiceGroup.server"> <summary> <para type="description">Specify the name the server</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Lb.Bindings.removeNSserverToServiceGroup.port"> <summary> <para type="description">Specify the port</para> </summary> </member> <member name="T:au.com.kloud.netscaler.Resource.Config.Lb.Bindings.removeNSserviceTovserver"> <summary> <para type="synopsis">The remove-NSserviceTovserver removes a service binding to a vserver. Requires the vserver name and the service name. </para> <para type="description">The remove-NSserviceTovserver removes a service to a vserver. Requires the vserver name and the service name.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Lb.Bindings.removeNSserviceTovserver.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Lb.Bindings.removeNSserviceTovserver.servicename"> <summary> <para type="description">Specify the name of the service to unbind. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Lb.Bindings.removeNSserviceTovserver.vserver"> <summary> <para type="description">Specify the name of the vserver to unbind from.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Lb.Monitor.getNSmonitor.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="T:au.com.kloud.netscaler.Resource.Config.Lb.Monitor.newNSmonitor"> <summary> <para type="synopsis">The new-NSmonitor creates a monitor.</para> <para type="description">Use the new-NSmonitor to create a monitor. Monitors can be used by load balancing and GSLB. Depending on the type, some parameters will need to be provided. </para> </summary> <example> <para>Creating a DNS monitor</para> <code>new-nsmonitor -session $session -name "LB-DNS-mon" -type "DNS" -query "domain.com" -querytype "zone" -radAccountType 5</code> </example> <example> <para>Creating an LDAP monitor to monitor Active Directory LDAP servers (DC) </para> <code>new-nsmonitor -session $session -name "LB-LDAPS-mon" -type "LDAP" -scriptname "nsldap.pl" -basedn "DC=domain,DC=com" -binddn "administrator@domain.com" -filter "CN=Builtin" -password "password"</code> </example> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Lb.Monitor.newNSmonitor.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Lb.Monitor.newNSmonitor.name"> <summary> <para type="description">Provide the name of the monitor. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Lb.Monitor.newNSmonitor.type"> <summary> <para type="description">Provide the type of the monitor. Possible values = PING, TCP, HTTP, TCP-ECV, HTTP-ECV, UDP-ECV, DNS, FTP, LDNS-PING, LDNS-TCP, LDNS-DNS, RADIUS, USER, HTTP-INLINE, SIP-UDP, SIP-TCP, LOAD, FTP-EXTENDED, SMTP, SNMP, NNTP, MYSQL, MYSQL-ECV, MSSQL-ECV, ORACLE-ECV, LDAP, POP3, CITRIX-XML-SERVICE, CITRIX-WEB-INTERFACE, DNS-TCP, RTSP, ARP, CITRIX-AG, CITRIX-AAC-LOGINPAGE, CITRIX-AAC-LAS, CITRIX-XD-DDC, ND6, CITRIX-WI-EXTENDED, DIAMETER, RADIUS_ACCOUNTING, STOREFRONT, APPC, SMPP, CITRIX-XNC-ECV, CITRIX-XDM, CITRIX-STA-SERVICE, CITRIX-STA-SERVICE-NHOP </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Lb.Monitor.newNSmonitor.action"> <summary> <para type="description">Provide the action for the monitor. The default of "DOWN" will mark the service/service group down when the monitor fails. "LOG" will only it, and "NONE" will take any action, however counts are still tracked. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Lb.Monitor.newNSmonitor.secure"> <summary> <para type="description">Set to "YES" if the target is a secure service for example https or LDAPS. Only for TCP based monitors, cannot be used by the CITRIX-AG monitor that is already secure by default. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Lb.Monitor.newNSmonitor.scriptname"> <summary> <para type="description">Specify the script name if using a script in the monitor. The script must be installed on the NetScaler in /nsconfig/monitors. Example: "nsldap.pl" for LDAP monitors </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Lb.Monitor.newNSmonitor.scriptargs"> <summary> <para type="description">Some scripts can use arguments. Specify them using this parameter. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Lb.Monitor.newNSmonitor.returnobject"> <summary> <para type="description">If set to true, the object that is created is returned. This is useful to testing purposes.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Lb.Monitor.newNSmonitor.basedn"> <summary> <para type="description">Provide the baseDN for an LDAP monitor. Ex. "DC=domain,DC=com" </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Lb.Monitor.newNSmonitor.binddn"> <summary> <para type="description">Provide the bind for an LDAP monitor. This refers to the account used to connect to LDAP. It must have read permissions. Ex. "user@domain.com" </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Lb.Monitor.newNSmonitor.filter"> <summary> <para type="description">Provide a filter for the LDAP monitor. When monitoring Active Directory, set this to "CN=Builtin" and set the baseDN to the root of the domain like "DC=domain,DC=com". </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Lb.Monitor.newNSmonitor.attribute"> <summary> <para type="description">Specify the attribute to search for use with the LDAP monitor. Usually not required when using Active Directory. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Lb.Monitor.newNSmonitor.password"> <summary> <para type="description">Specify the password of the user account set with the binddn parameter. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Lb.Monitor.newNSmonitor.application"> <summary> <para type="description">Provide the name of the application. ONLY for CITRIX-XML-SERVICE monitors.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Lb.Monitor.newNSmonitor.domain"> <summary> <para type="description">Provide the domain name, for XenDesktop DDC monitors</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Lb.Monitor.newNSmonitor.storename"> <summary> <para type="description">Provide the storename, only for monitoring storefront servers</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Lb.Monitor.newNSmonitor.storefrontacctservice"> <summary> <para type="description">Enable probing of StoreFront Account Service. Either "YES" or "NO". Default "YES". Only for StoreFront monitors.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Lb.Monitor.newNSmonitor.storefrontcheckbackendservices"> <summary> <para type="description">Enable probing of services running on storefront server. Either "YES" or "NO". Default "NO". Only for StoreFront monitors.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Lb.Monitor.newNSmonitor.httprequest"> <summary> <para type="description">Specify the request for HTTP monitors. Ex, "HEAD/" </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Lb.Monitor.newNSmonitor.respcode"> <summary> <para type="description">Specify an array of strings containing the response codes to mark a service as up. The most common is "200" which means OK. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Lb.Monitor.newNSmonitor.customheaders"> <summary> <para type="description">Specify the the custom header for HTTP monitors. Ex, "HEAD/" </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Lb.Monitor.newNSmonitor.send"> <summary> <para type="description">The send string for TCP-ECV, HTTP-ECV and UDP-ECV monitors </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Lb.Monitor.newNSmonitor.recv"> <summary> <para type="description">The receive string for TCP-ECV, HTTP-ECV and UDP-ECV monitors </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Lb.Monitor.newNSmonitor.query"> <summary> <para type="description">The query for a DNS monitor. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Lb.Monitor.newNSmonitor.querytype"> <summary> <para type="description">The querytype for a DNS monitor. Possible values = Address, Zone, AAAA </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Lb.Monitor.newNSmonitor.ipaddress"> <summary> <para type="description">Provide a string array containing value IP address responses for a DNS monitor. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Lb.Monitor.newNSmonitor.destip"> <summary> <para type="description">Provide a destination IP </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Lb.Monitor.newNSmonitor.destport"> <summary> <para type="description">Provide a destination port </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Lb.Monitor.newNSmonitor.lrtm"> <summary> <para type="description">Enable probing of least response time. Either "ENABLED" or "DISABLED". Default "DISABLED"</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Lb.Monitor.newNSmonitor.reverse"> <summary> <para type="description">Reverse the monitor. Failure of the monitor marks the service as up and vice versa. Valid options are "YES" or "NO". Default "NO" </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Lb.Monitor.newNSmonitor.radaccounttype"> <summary> <para type="description">Account status type for RADIUS_ACCOUNTING monitors. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Lb.Monitor.newNSmonitor.radkey"> <summary> <para type="description">Radius Key for a radius monitor. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Lb.Monitor.newNSmonitor.radnasid"> <summary> <para type="description">NAS ID for a radius monitor. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Lb.Monitor.newNSmonitor.radnasip"> <summary> <para type="description">NAS IP for a radius monitor. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Lb.Monitor.newNSmonitor.username"> <summary> <para type="description">Specify a username. Used by several monitors. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Lb.Monitor.RemoveNSmonitor.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Lb.Monitor.RemoveNSmonitor.name"> <summary> <para type="description">Provide the name of the service to delete.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Lb.Monitor.RemoveNSmonitor.monitorobject"> <summary> <para type="description">Provide the service as a service object to delete. To get a service object, use the get-nsservice command</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Lb.Monitor.setNSmonitor.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Lb.Monitor.setNSmonitor.returnobject"> <summary> <para type="description">If set to true, the object that is updated is returned. This is useful to testing purposes.</para> </summary> </member> <member name="T:au.com.kloud.netscaler.Resource.Config.Lb.getNSlbvserver"> <summary> <para type="synopsis">The get-NSlbvserver returns a lbvserver object. </para> <para type="description">Use the get-NSlbvserver command to find a vserver. The vserver is returned as an object that can be modified.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Lb.getNSlbvserver.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Lb.getNSlbvserver.name"> <summary> <para type="description">Provide the name of the virtual server to get. </para> </summary> </member> <member name="T:au.com.kloud.netscaler.Resource.Config.Lb.syncnslbvserver"> <summary> <para type="synopsis">The sync-NSlbvserver allows for a fast update of the services bound to a vserver</para> <para type="description">the sync-nslbvserver is used to update the services bound to an LB vserver. It takes array of IP addresses and uses that confirm the services that should be bound. If a service is missing it is created. Similarly, IP addresses NOT included will also be removed. It's a fast way of updating a lB vserver for example when using scalesets.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Lb.syncnslbvserver.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Lb.syncnslbvserver.ipaddress"> <summary> <para type="description">Specify an array of IP addresses (strings) that specify which services should be bound to the vserver. This specifies the end state. Hence, if an IP address is not included but has a matching service, that service is unbound and removed.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Lb.syncnslbvserver.vserver"> <summary> <para type="description">Specify the name of the virtual server. This is required. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Lb.syncnslbvserver.port"> <summary> <para type="description">specify the ports for the service. If no services currently exist, port from vserver will be used. Otherwise, this function will use the port used by the first service current bound to the vserver</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Lb.syncnslbvserver.serviceType"> <summary> <para type="description">Specify the service type. If no services exist, the service type will be same as the vserver, otherwise values from first service will be used. Possible values = HTTP, FTP, TCP, UDP, SSL, SSL_BRIDGE, SSL_TCP, DTLS, NNTP, RPCSVR, DNS, ADNS, SNMP, RTSP, DHCPRA, ANY, SIP_UDP, SIP_TCP, SIP_SSL, DNS_TCP, ADNS_TCP, MYSQL, MSSQL, ORACLE, RADIUS, RADIUSListener, RDP, DIAMETER, SSL_DIAMETER, TFTP, SMPP, PPTP, GRE, SYSLOGTCP, SYSLOGUDP, FIX, SSL_FIX, USER_TCP, USER_SSL_TCP .</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Lb.syncnslbvserver.monitor"> <summary> <para type="description">specify the name of the monitor(s) to use. If not specified, then the monitor(s) used by the first existing service is used, or default is set. Specifying this may update existing services to use this monitor</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Lb.syncnslbvserver.serviceNamingPattern"> <summary> <para type="description">Specify the naming pattern for the service. this consist of a prefix, index and suffix.Specify a string with ##index## where the index goes. "LB-web-##index##-svc" </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Lb.syncnslbvserver.force"> <summary> <para type="description">If set, force deletion without confirmation.</para> </summary> </member> <member name="T:au.com.kloud.netscaler.Resource.Config.Lb.newNSlbvserver"> <summary> <para type="synopsis">The new-NSlbvserver creates a load balancing virtual server.</para> <para type="description">Use the new-NSlbvserver command to create a load balancing vserver. Without IP address, the server is non-addressable, you can specify a single IP with -ipv46, or a pattern with -ippattern and ipmask </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Lb.newNSlbvserver.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Lb.newNSlbvserver.ipv46"> <summary> <para type="description">Specify the IP address. You can specify the IP address with this parameter, or a pattern with the -ippattern parameter. If neither is used, the vserver will be non-addressable. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Lb.newNSlbvserver.name"> <summary> <para type="description">Specify the name of the virtual server. This is required. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Lb.newNSlbvserver.comment"> <summary> <para type="description">Specify an optional comment. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Lb.newNSlbvserver.ippattern"> <summary> <para type="description">Specify an IP pattern. When using -ippattern, you must use -ipmask as well. For example -ippattern "10.0.0.4" -ipmask "255.255.255.254" will make the vserver listen on IP 10.0.0.4 and 10.0.0.5. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Lb.newNSlbvserver.ipmask"> <summary> <para type="description">Specify the IP mask.Required whn using -ippattern. For example -ippattern "10.0.0.4" -ipmask "255.255.255.254" will make the vserver listen on IP 10.0.0.4 and 10.0.0.5. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Lb.newNSlbvserver.lbmethod"> <summary> <para type="description">Specify the load balancing method. Possible values = ROUNDROBIN, LEASTCONNECTION, LEASTRESPONSETIME, URLHASH, DOMAINHASH, DESTINATIONIPHASH, SOURCEIPHASH, SRCIPDESTIPHASH, LEASTBANDWIDTH, LEASTPACKETS, TOKEN, SRCIPSRCPORTHASH, LRTM, CALLIDHASH, CUSTOMLOAD, LEASTREQUEST, AUDITLOGHASH, STATICPROXIMITY, USER_TOKEN. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Lb.newNSlbvserver.persistencetype"> <summary> <para type="description">Specify the persistence type. Possible values = SOURCEIP, COOKIEINSERT, SSLSESSION, RULE, URLPASSIVE, CUSTOMSERVERID, DESTIP, SRCIPDESTIP, CALLID, RTSPSID, DIAMETER, FIXSESSION, USERSESSION, NONE </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Lb.newNSlbvserver.port"> <summary> <para type="description">Specify the port. Not required for a non-addressable vserver. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Lb.newNSlbvserver.servicetype"> <summary> <para type="description">Specify the service type. Possible values = HTTP, FTP, TCP, UDP, SSL, SSL_BRIDGE, SSL_TCP, DTLS, NNTP, DNS, DHCPRA, ANY, SIP_UDP, SIP_TCP, SIP_SSL, DNS_TCP, RTSP, PUSH, SSL_PUSH, RADIUS, RDP, MYSQL, MSSQL, DIAMETER, SSL_DIAMETER, TFTP, ORACLE, SMPP, SYSLOGTCP, SYSLOGUDP, FIX, SSL_FIX, USER_TCP, USER_SSL_TCP </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Lb.newNSlbvserver.state"> <summary> <para type="description">Specify the initial state of the vserver. Default is "ENABLED". Possible values are "ENABLED", "DISABLED" </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Lb.newNSlbvserver.returnobject"> <summary> <para type="description">If set to true, the object that is created is returned. This is useful to testing purposes.</para> </summary> </member> <member name="T:au.com.kloud.netscaler.Resource.Config.Lb.removeNSlbvserver"> <summary> <para type="synopsis">The remove-NSlbvserver deletes a lbvserver. </para> <para type="description">Use the remove-NSlbvserver command to delete a vserver.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Lb.removeNSlbvserver.session"> <summary> <para type="description">This parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Lb.removeNSlbvserver.name"> <summary> <para type="description">Provide the name of the virtual server to delete.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Lb.removeNSlbvserver.server"> <summary> <para type="description">Provide load balancing vserver to delete as an object, such as generated by get-nslbvserver</para> </summary> </member> <member name="T:au.com.kloud.netscaler.Resource.Config.Lb.setNSlbvserver"> <summary> <para type="synopsis">The set-NSlbvserver applies changes made to a vserver object</para> <para type="description">Use the set-NSlbvserver command apply changes to a vserver object. First fetch the object using get-nslbvserver, change properties and then use this command to apply them.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Lb.setNSlbvserver.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="P:au.com.kloud.netscaler.Resource.Config.Lb.setNSlbvserver.vserver"> <summary> <para type="description">Provide vserver object.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Lb.setNSlbvserver.returnobject"> <summary> <para type="description">If set to true, the object that is created is returned. This is useful to testing purposes.</para> </summary> </member> <member name="T:au.com.kloud.netscaler.Resource.Config.Network.Route.getnsroute"> <summary> <para type="synopsis">The get-nsroute returns all routes as route objects. </para> <para type="description">The get-nsroute returns one or more routes. Without filter all routes are returned. You can filter by using the fitler parameter.</para> </summary> <example> <code>get-nsroute</code> <para>returns all routes</para> </example> <example> <code>get-nsroute -filter "gateway:10.0.1.1"</code> <para>returns all routes with gateway set to "10.0.1.1"</para> </example> <example> <code>get-nsroute -filter "network:10.0.1.0,gateway:10.0.1.1"</code> <para>returns all routes for network "10.0.1.0" with gateway set to "10.0.1.1"</para> </example> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Network.Route.getnsroute.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <!-- Badly formed XML comment ignored for member "F:au.com.kloud.netscaler.Resource.Config.Network.Route.getnsroute.filter" --> <member name="T:au.com.kloud.netscaler.Resource.Config.Network.Route.newnsroute"> <summary> <para type="synopsis">The new-nsroute a new route.</para> <para type="description">Use new-nsroute to create a new route on the NetScaler</para> </summary> <example> <code>new-nsroute -network "0.0.0.0" -netmask "0.0.0.0" -gateway "10.0.1.1"</code> <para>create a static default route entry</para> </example> <example> <code>new-nsroute -routeobject $routes</code> <para>Create a route using an object in an array (this allows for bulk import by creating an array of objects).</para> </example> <example> <code>$route = new-nsroute -network "0.0.0.0" -netmask "0.0.0.0" -gateway "10.0.1.1" -returnobject $true</code> <para>creates a route object, returns the object and stores it in the $route variable.</para> </example> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Network.Route.newnsroute.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Network.Route.newnsroute.network"> <summary> <para type="description">Specify the network.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Network.Route.newnsroute.netmask"> <summary> <para type="description">Specify the subnet mask. The format is 4 octets such as "255.255.255.0"</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Network.Route.newnsroute.gateway"> <summary> <para type="description">Specify the gateway</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Network.Route.newnsroute.routeobject"> <summary> <para type="description">Create a PSObject with following properties: network, netmask, gateway. This parameter will accept an array of these objects to create in bulk.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Network.Route.newnsroute.returnobject"> <summary> <para type="description">If set to true, the object that is created is returned. This is useful to testing purposes.</para> </summary> </member> <member name="T:au.com.kloud.netscaler.Resource.Config.Network.Route.removensroute"> <summary> <para type="synopsis">The remove-nsroute allows for deletion of route objects</para> <para type="description">Use remove-nsroute to delete a route. The route must be stored in an object such as what you get from get-nsroute. This command will accept an array.</para> </summary> <example> <code>remove-nsroute $route</code> <para>Remove the route stored in the $route object (can be an array).</para> </example> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Network.Route.removensroute.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Network.Route.removensroute.nsroute"> <summary> <para type="description">Provide the route to delete as a route object </para> </summary> </member> <member name="T:au.com.kloud.netscaler.Resource.Config.Network.Route.setnsroute"> <summary> <para type="synopsis">The set-nsroute allows you to change settings about a route.</para> <para type="description">Use set-nsroute to submit changes to existing routes. The command either gets a filter to match a single route, or gets a route object with modification.</para> </summary> <example> <code>set-nsroute -route $route</code> <para>submits changes made to the $route object. Use get-nsroute to get the $route object. </para> </example> <example> <code>set-nsroute -filter "network:10.0.1.0",netmask:255.255.255.0" -gateway "10.2.3.4"</code> <para>Change the gateway for network 10.0.1.0/255.255.255.0</para> </example> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Network.Route.setnsroute.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Network.Route.setnsroute.routeToSet"> <summary> <para type="description">Specify the route to set. Route must be specied as an object (or array of objects). </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Network.Route.setnsroute.filter"> <summary> <para type="description">Specify a filter that will return only one result. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Network.Route.setnsroute.gateway"> <summary> <para type="description">Specify the new gateway for this route.</para> </summary> </member> <member name="T:au.com.kloud.netscaler.Resource.Config.Ns.getNSHardware"> <summary> <para type="synopsis">The get-nshardware command gets hardware details about the netscaler.</para> <para type="description">Use the get-NShardware command to get details about the NetScaler harware such as serial number and host ID. It requires a nitro_service object as input which is requested using get-nitrosession. </para> </summary> <example> <code>get-nshardware</code> <para>Get details about the hardware.</para> </example> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Ns.getNSHardware.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="T:au.com.kloud.netscaler.Resource.Config.Ns.NsConfig.setNStimezone"> <summary> <para type="synopsis">The set-nstimezone command gets sets the timezone for the netscaler.</para> <para type="description">Use the set-nstimezone command to set the timezone of the NetScaler. Requires a nitro_service object and a string containing the timezone. </para> </summary> <example> <code>set-nstimezone -timezone "GMT+11:00-AEDT-Australia/Sydney"</code> <para>set the timezone.</para> </example> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Ns.NsConfig.setNStimezone.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Ns.NsConfig.setNStimezone.timezone"> <summary> <para type="description">Provide the timezone as a string, similar to how it would be presented in the ns.conf. ex. "GMT+11:00-AEDT-Australia/Sydney" </para> </summary> </member> <member name="T:au.com.kloud.netscaler.Resource.Config.Ns.Nsip.getnsip"> <summary> <para type="synopsis">The get-nsip returns all ip addresses as objects.</para> <para type="description">The get-nsip command returns a NSIP object. Some of the values of this object can be changed and pushed back to the NetScaler with the set-NSIP command. </para> </summary> <example> <code>get-NSIP</code> <para>retrieve all NetScaler IPs</para> </example> <example> <code>get-NSIP -filter "iptype:snip"</code> <para>retrieve all subnet IPs</para> </example> <example> <para>get the IP based on IP address</para> <code>get-NSIP -filter "ipaddress:10.0.1.1"</code> <para>get the IP based on IP address</para> </example> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Ns.Nsip.getnsip.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Ns.Nsip.getnsip.filter"> <summary> <para type="description">This optional parameter requires allows you to specify a filter. e.g. "ipaddress:x.x.x.x", or "iptype:vip"</para> </summary> </member> <member name="T:au.com.kloud.netscaler.Resource.Config.Ns.Nsip.newNSIP"> <summary> <para type="synopsis">The new-nsip command creates a new NetScaler IP address.</para> <para type="description">The new-nsip creates a new IP address. Multiple options can be set. As all options are strings, disable options by setting the value to "DISABLED", or "ENABLED" based on what is needed. For example -gui "ENABLED" enables the GUI option. </para> </summary> <example> <code>new-NSIP -ipaddress "10.0.1.1" -netmask "255.255.255.0"</code> <para>create a subnet IP</para> </example> <example> <code>new-NSIP -ipaddress "10.0.1.1" -netmask "255.255.255.0" -type "MIP" -returnobject $true</code> <para>create a MIP, and return the address that was created as an object</para> </example> <example> <code>new-NSIP -ipaddress "10.0.1.1" -netmask "255.255.255.0" -gui "ENABLED" -mgmtaccess "ENABLED"</code> <para>create a SNIP and enable GUI and management</para> </example> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Ns.Nsip.newNSIP.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Ns.Nsip.newNSIP.ftp"> <summary> <para type="description">This parameter is either "DISABLED" or "ENABLED". Default is "DISABLED". </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Ns.Nsip.newNSIP.gui"> <summary> <para type="description">This parameter is either "DISABLED" or "ENABLED". Default is "DISABLED". Requires mgmtaccess to be enabled as well. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Ns.Nsip.newNSIP.icmp"> <summary> <para type="description">This parameter is either "DISABLED" or "ENABLED". Default is "ENABLED". </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Ns.Nsip.newNSIP.arp"> <summary> <para type="description">This parameter is either "DISABLED" or "ENABLED". Default is "ENABLED". </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Ns.Nsip.newNSIP.ipaddress"> <summary> <para type="description">Specify the IP address as a string. This is mandatory</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Ns.Nsip.newNSIP.netmask"> <summary> <para type="description">Specify the netmask as a string. This is mandatory </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Ns.Nsip.newNSIP.mgmtaccess"> <summary> <para type="description">Enable management access cotnrol. This parameter is either "DISABLED" or "ENABLED". Default is "DISABLED". </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Ns.Nsip.newNSIP.restrictaccess"> <summary> <para type="description">Allow access only to management applications. This parameter is either "DISABLED" or "ENABLED". Default is "ENABLED". </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Ns.Nsip.newNSIP.snmp"> <summary> <para type="description">This parameter is either "DISABLED" or "ENABLED". Default is "DISABLED". </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Ns.Nsip.newNSIP.ssh"> <summary> <para type="description">This parameter is either "DISABLED" or "ENABLED". Default is "DISABLED". Requires mgmtaccess to be enabled as well. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Ns.Nsip.newNSIP.telnet"> <summary> <para type="description">This parameter is either "DISABLED" or "ENABLED". Default is "DISABLED". Requires mgmtaccess to be enabled as well. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Ns.Nsip.newNSIP.state"> <summary> <para type="description">This parameter is either "DISABLED" or "ENABLED". Default is "ENABLED". </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Ns.Nsip.newNSIP.type"> <summary> <para type="description">Specify the type of IP address, either SNIP, MIP, CLIP, GSLBsiteIP, LSN. Default is SNIP </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Ns.Nsip.newNSIP.vserver"> <summary> <para type="description">This parameter is either "DISABLED" or "ENABLED". Default is "DISABLED". </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Ns.Nsip.newNSIP.returnobject"> <summary> <para type="description">If set to true, the object that is created is returned. This is useful to testing purposes.</para> </summary> </member> <member name="T:au.com.kloud.netscaler.Resource.Config.Ns.Nsip.setnsip"> <summary> <para type="synopsis">The set-nsip allows you to save changes made to a ip object.</para> <para type="description">Get an IP object with get-nsip, change it, and use set-nsip to submit the changes. Note, not all properties can be changed.</para> </summary> <example> <code>set-nsip -nsiptomodify $ip</code> <para>get an IP, change it and submit the changes</para> </example> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Ns.Nsip.setnsip.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Ns.Nsip.setnsip.nsipToModify"> <summary> <para type="description">Specify the NSIP to modify. This requires an NSIP object as returned by get-nsip. Please note, this does not take an array.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Ns.Nsip.setnsip.returnobject"> <summary> <para type="description">If set to true, the object that is updated is returned. This is useful to testing purposes.</para> </summary> </member> <member name="T:au.com.kloud.netscaler.Resource.Config.Ns.NsTimeOut.GetNsTimeOut"> <summary> <para type="synopsis">The get-nstimeout gets the current the NetScaler timeout parameters (global settings). </para> <para type="description">Use this to set the parameters</para> </summary> </member> <member name="T:au.com.kloud.netscaler.Resource.Config.Ns.NsTimeOut.setNsTimeOut"> <summary> <para type="synopsis">The set-nstimeout updates the NetScaler timeout parameters (global settings). This is to configure the appliance timeouts which is different from timeouts you may specify on virtual servers etc. </para> <para type="description">Use this to set the parameters</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Ns.NsTimeOut.setNsTimeOut.anyclient"> <summary> <para type="description">Global idle timeout, in seconds, for non-TCP client connections </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Ns.NsTimeOut.setNsTimeOut.anyserver"> <summary> <para type="description">Global idle timeout, in seconds, for non TCP server connections</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Ns.NsTimeOut.setNsTimeOut.anytcpclient"> <summary> <para type="description">Global idle timeout, in seconds, for TCP client connections</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Ns.NsTimeOut.setNsTimeOut.anytcpserver"> <summary> <para type="description">Global idle timeout, in seconds, for TCP server connections</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Ns.NsTimeOut.setNsTimeOut.client"> <summary> <para type="description">Client idle timeout (in seconds).</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Ns.NsTimeOut.setNsTimeOut.halfclose"> <summary> <para type="description">Idle timeout, in seconds, for connections that are in TCP half-closed state</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Ns.NsTimeOut.setNsTimeOut.httpclient"> <summary> <para type="description">Global idle timeout, in seconds, for client connections of HTTP service type</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Ns.NsTimeOut.setNsTimeOut.httpserver"> <summary> <para type="description">Global idle timeout, in seconds, for server connections of HTTP service type</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Ns.NsTimeOut.setNsTimeOut.newconnidletimeout"> <summary> <para type="description">Timer interval, in seconds, for new TCP NATPCB connections on which no data was received</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Ns.NsTimeOut.setNsTimeOut.nontcpzombie"> <summary> <para type="description">Interval at which the zombie clean-up process for non-TCP connections should run</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Ns.NsTimeOut.setNsTimeOut.reducedfintmeout"> <summary> <para type="description">Alternative idle timeout, in seconds, for closed TCP NATPCB connections</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Ns.NsTimeOut.setNsTimeOut.reducedrsttimeout"> <summary> <para type="description">Timer interval, in seconds, for abruptly terminated TCP NATPCB connections</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Ns.NsTimeOut.setNsTimeOut.server"> <summary> <para type="description">Server idle timeout (in seconds)</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Ns.NsTimeOut.setNsTimeOut.tcpclient"> <summary> <para type="description">Global idle timeout, in seconds, for non-HTTP client connections of TCP service type</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Ns.NsTimeOut.setNsTimeOut.tcpserver"> <summary> <para type="description">Global idle timeout, in seconds, for non-HTTP server connections of TCP service type</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Ns.NsTimeOut.setNsTimeOut.zombie"> <summary> <para type="description">Interval, in seconds, at which the NetScaler zombie cleanup process must run</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Ns.NsTimeOut.setNsTimeOut.returnobject"> <summary> <para type="description">If set to true, the object that is updated is returned. This is useful to testing purposes.</para> </summary> </member> <member name="T:au.com.kloud.netscaler.Resource.Config.Rewrite.Action.getNSrewriteaction"> <summary> <para type="synopsis">The get-NSrewriteaction fetches a rewrite action.</para> <para type="description">The get-NSrewriteaction fetches a rewrite action.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Rewrite.Action.getNSrewriteaction.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Rewrite.Action.getNSrewriteaction.name"> <summary> <para type="description">Specify the name of the action</para> </summary> </member> <member name="T:au.com.kloud.netscaler.Resource.Config.Rewrite.Action.addNSrewriteaction"> <summary> <para type="synopsis">The new-NSrewriteaction creates a rewrite action.</para> <para type="description">The new-NSrewriteaction creates a rewrite action.</para> </summary> <example> <para>creating an action to insert a Strict-Transport-Security header with value. </para> <code>add-nsrewriteaction -session $session -name "Insert-STS-Header-rwact" -type "INSERT_HTTP_HEADER" -target "Strict-Transport-Security" -expression '"max-age=157680000"'</code> </example> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Rewrite.Action.addNSrewriteaction.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Rewrite.Action.addNSrewriteaction.name"> <summary> <para type="description">Specify the name of the action</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Rewrite.Action.addNSrewriteaction.comment"> <summary> <para type="description">Specify a comment</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Rewrite.Action.addNSrewriteaction.target"> <summary> <para type="description">Use target to specify the header in case of for example an INSERT_HTTP_HEADER action. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Rewrite.Action.addNSrewriteaction.type"> <summary> <para type="description">Specify the type of action. Possible values = noop, delete, insert_http_header, delete_http_header, corrupt_http_header, insert_before, insert_after, replace, replace_http_res, delete_all, replace_all, insert_before_all, insert_after_all, clientless_vpn_encode, clientless_vpn_encode_all, clientless_vpn_decode, clientless_vpn_decode_all, insert_sip_header, delete_sip_header, corrupt_sip_header, replace_sip_res, replace_diameter_header_field, replace_dns_header_field, replace_dns_answer_section </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Rewrite.Action.addNSrewriteaction.expression"> <summary> <para type="description">Specify the expression for the rewrite policy. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Rewrite.Action.addNSrewriteaction.returnobject"> <summary> <para type="description">If set to true, the object that is created is returned. This is useful to testing purposes.</para> </summary> </member> <member name="T:au.com.kloud.netscaler.Resource.Config.Rewrite.Policy.newNSrewritepolicy"> <summary> <para type="synopsis">The new-NSrewritepolicy creates a rewrite policy.</para> <para type="description">Use to create a rewrite policy </para> </summary> <example> <para>creating a rewrite policy</para> <code>add-nsrewritepolicy -session $session -name "Enforce-STS-rwpol" -action "Insert-STS-Header-rwact" -rule "true"</code> </example> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Rewrite.Policy.newNSrewritepolicy.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Rewrite.Policy.newNSrewritepolicy.name"> <summary> <para type="description">Name of the rewrite policy. Mandatory </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Rewrite.Policy.newNSrewritepolicy.action"> <summary> <para type="description">Name of the rewrite action to use. Mandatory </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Rewrite.Policy.newNSrewritepolicy.comment"> <summary> <para type="description">Specify a comment if desired. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Rewrite.Policy.newNSrewritepolicy.undefaction"> <summary> <para type="description">Action to perform if the rule evaluates to 'undefined'. Options are: "NOREWRITE","RESET","DROP".</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Rewrite.Policy.newNSrewritepolicy.rule"> <summary> <para type="description">The expression to evaluate when the policies should apply. Use 'true' to apply without a filter.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Rewrite.Policy.newNSrewritepolicy.returnobject"> <summary> <para type="description">If set to true, the object that is created is returned. This is useful to testing purposes.</para> </summary> </member> <member name="T:au.com.kloud.netscaler.Resource.Config.Ssl.Cert.getNScertificate"> <summary> <para type="description">This cmdlet returns a certificate object.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Ssl.Cert.getNScertificate.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="T:au.com.kloud.netscaler.Resource.Config.Ssl.Cert.newNScertificate"> <summary> <para type="synopsis">The new-nscertificate command creates a certificate based on existing certificate and key file.</para> <para type="description">The new-nscertificate command creates a certificate based on existing certificate and key file.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Ssl.Cert.newNScertificate.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Ssl.Cert.newNScertificate.name"> <summary> <para type="description">Provide the name of the certificate in NetScaler. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Ssl.Cert.newNScertificate.certificate"> <summary> <para type="description">Provide the cert file name. Must match the file installed on /nsconfig/ssl </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Ssl.Cert.newNScertificate.key"> <summary> <para type="description">Provide the name of the private key file. Must match the file installed on /nsconfig/sll </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Ssl.Cert.newNScertificate.returnobject"> <summary> <para type="description">If set to true, the object that is created is returned. This is useful to testing purposes.</para> </summary> </member> <member name="T:au.com.kloud.netscaler.Resource.Config.Ssl.Cert.setNScertificate"> <summary> <para type="description">This cmdlet processes updates to a certificate object.The only values that can be changed as linkcertkeyname, expirymonitor, notificationperiod and name (property called certkey). </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Ssl.Cert.setNScertificate.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Ssl.Cert.setNScertificate.returnobject"> <summary> <para type="description">If set to true, the object that is created is returned. This is useful to testing purposes.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Ssl.SslProfile.getNSsslprofile.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Ssl.SslProfile.newNSsslprofile.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Ssl.SslProfile.newNSsslprofile.returnobject"> <summary> <para type="description">If set to true, the object that is created is returned. This is useful to testing purposes.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Ssl.SslProfile.removeNSsslprofile.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Ssl.SslProfile.setNSsslprofile.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.Ssl.SslProfile.setNSsslprofile.returnobject"> <summary> <para type="description">If set to true, the object that is created is returned. This is useful to testing purposes.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.System.SystemFile.AddNSFile.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="P:au.com.kloud.netscaler.Resource.Config.System.SystemFile.AddNSFile.Path"> <summary> <para type="description">Specify the source path. This can be a folder (c:\files), a file .\certificate.cer, or even all files in the current path: .\*.*, all files of a particular type .\*.pfx </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.System.SystemFile.AddNSFile.destinationpath"> <summary> <para type="description">This mandatory parameter specifies the destination path of the file on the NetScaler. Ex "/nsconfig/ssl" </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.System.SystemFile.AddNSFile.recursive"> <summary> <para type="description">The recusive parameter will also traverse the folder structure. Be aware however, that the nitro API does not support the creation of folders so, all files will end-up in the same destination. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.System.SystemFile.AddNSFile.overwrite"> <summary> <para type="description">If a file already exists, the upload will fail. By setting the overwrite switch, the file is first deleted from the NetScaler before it's uploaded.</para> </summary> </member> <member name="T:au.com.kloud.netscaler.Resource.Config.System.SystemFile.GetNSFiles"> <summary> <para type="description">This cmdlet returns the file names of files in a particular path. This is similar to ls, or dir.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.System.SystemFile.GetNSFiles.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.System.SystemFile.GetNSFiles.Path"> <summary> <para type="description">specify the path where to fetch the file(s) from.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.System.SystemFile.GetNSFiles.fullpath"> <summary> <para type="description">specifying fullpath will list all the files with the full path. Otherwise files and directories in the path are specified.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.Resource.Config.System.SystemFile.GetNSFiles.recursive"> <summary> <para type="description">recursive enables a recursive search. enabling recursive search with full path will only return files, not directories (however all contents of a directory are returned.</para> </summary> </member> <member name="T:au.com.kloud.netscaler.Service.newNitroSession"> <summary> <para type="synopsis">The new-nitrosession command establishes a session with the NetScaler.</para> <para type="description">The new-nitrosession is used to connect and authenticate with a NetScaler. It requires a username, password, NSIP, as well as specifying whether you are connecting using HTTP or HTTPS. It returns a nitro_service object which is the input for all other commands. </para> </summary> <example> <code>$session = new-nitrosession -username "citrix" -password "citrix123" -nsip "1.2.3.4" -https $true</code> <para>Create a nitro session and store the output in a variable.</para> </example> </member> <member name="F:au.com.kloud.netscaler.Service.newNitroSession.credential"> <summary> <para type="description">The credential parameter allows the use of a PSCredential object rather than a username, password pair. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Service.newNitroSession.NSIP"> <summary> <para type="description">The NSIP parameter specifies the destination IP adddress. This is usually the NSIP, however can be a SNIP provided it has management access enabled </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Service.newNitroSession.HTTPS"> <summary> <para type="description">The HTTPS parameter specifies whether HTTPS is used to connect. Defaults to HTTP. This parameter is optional. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.Service.newNitroSession.Secure"> <summary> <para type="description">Alternative to using -HTTPS:$true. This parameter enables a connection over HTTPS </para> </summary> </member> <member name="F:au.com.kloud.netscaler.addnscertTovserver.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.addnscertTovserver.certificate"> <summary> <para type="description">Specify the name of the certificate </para> </summary> </member> <member name="F:au.com.kloud.netscaler.addnscertTovserver.vserver"> <summary> <para type="description">Specify the name of the target vserver</para> </summary> </member> <member name="F:au.com.kloud.netscaler.addnscertTovserver.ca"> <summary> <para type="description">Specify if the certificate being mapped is a CA certificate</para> </summary> </member> <member name="F:au.com.kloud.netscaler.addnscertTovserver.crlcheck"> <summary> <para type="description">Specify the type of crlcheck to use: Possible values are "Mandatory", "Optional". Only for CA certs.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.addnscertTovserver.ocspcheck"> <summary> <para type="description">Specify the type of ocspcheck to use: Possible values are "Mandatory", "Optional". Only for CA certs.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.addnscertTovserver.skipcaname"> <summary> <para type="description">Specify if the CA_Name of this CA certificate needs to be sent. Only for CA certs.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.addnscertTovserver.snicert"> <summary> <para type="description">Specify if the certificate will be used in SNI processing.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.newNSciphergroup.session"> <summary> <para type="description">This parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.addNScipherTogroup.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.removeNScipherTogroup.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="T:au.com.kloud.netscaler.addNScipherToVserver"> <summary> <para type="synopsis">This command binds a cipher to a vserver</para> <para type="description">This commdn binds a cipher to a vserver.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.addNScipherToVserver.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="T:au.com.kloud.netscaler.removeNScipherToVserver"> <summary> <para type="synopsis">This command unbinds a cipher to a vserver</para> <para type="description">This commdn unbinds a cipher to a vserver.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.removeNScipherToVserver.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="T:au.com.kloud.netscaler.getNSsslvserver"> <summary> <para type="synopsis">The get-NSsslvserver returns a lbvserver object. </para> <para type="description">Use the get-NSsslvserver command to find a vserver. The vserver is returned as an object that can be modified.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.getNSsslvserver.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.getNSsslvserver.name"> <summary> <para type="description">Provide the name of the virtual server to get. </para> </summary> </member> <member name="T:au.com.kloud.netscaler.setNSsslvserver"> <summary> <para type="synopsis">The set-NSlbvserver applies changes made to a vserver object</para> <para type="description">Use the set-NSlbvserver command apply changes to a vserver object. First fetch the object using get-nslbvserver, change properties and then use this command to apply them.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.setNSsslvserver.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="P:au.com.kloud.netscaler.setNSsslvserver.vserver"> <summary> <para type="description">Provide vserver object.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.formatnscertfile.session"> <summary> <para type="description">This parameter specifies a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.formatnscertfile.pfxfile"> <summary> <para type="description">PFX file to import convert to PEM</para> </summary> </member> <member name="F:au.com.kloud.netscaler.formatnscertfile.outfile"> <summary> <para type="description">PEM file that is to be created</para> </summary> </member> <member name="F:au.com.kloud.netscaler.formatnscertfile.importtype"> <summary> <para type="description">Specify the import file type.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.formatnscertfile.certfile"> <summary> <para type="description">Specify the input PEM certificate</para> </summary> </member> <member name="F:au.com.kloud.netscaler.formatnscertfile.keyfile"> <summary> <para type="description">Specify the input PEM key file</para> </summary> </member> <member name="F:au.com.kloud.netscaler.formatnscertfile.password"> <summary> <para type="description">Specify the password for the PFX file</para> </summary> </member> <member name="F:au.com.kloud.netscaler.formatnscertfile.pempassphrase"> <summary> <para type="description">Specify the password for the PEM key</para> </summary> </member> <member name="T:au.com.kloud.netscaler.addnscerttosslservice"> <summary> <para type="synopsis">The add-NScerttoSSLservice allow for the binding of a certificate to an SSL service</para> <para type="description">Use this to bind a certificate to a service. For example this can be used to bind a new certificate to built-in SSL services such as the GUI running on the NSIP</para> </summary> </member> <member name="F:au.com.kloud.netscaler.addnscerttosslservice.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.addnscerttosslservice.certificate"> <summary> <para type="description">Specify the name of the certificate </para> </summary> </member> <member name="F:au.com.kloud.netscaler.addnscerttosslservice.service"> <summary> <para type="description">Specify the name of the target service</para> </summary> </member> <member name="F:au.com.kloud.netscaler.addnscerttosslservice.ca"> <summary> <para type="description">Specify if the certificate being mapped is a CA certificate</para> </summary> </member> <member name="F:au.com.kloud.netscaler.addnscerttosslservice.crlcheck"> <summary> <para type="description">Specify the type of crlcheck to use: Possible values are "Mandatory", "Optional". Only for CA certs.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.addnscerttosslservice.ocspcheck"> <summary> <para type="description">Specify the type of ocspcheck to use: Possible values are "Mandatory", "Optional". Only for CA certs.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.addnscerttosslservice.skipcaname"> <summary> <para type="description">Specify if the CA_Name of this CA certificate needs to be sent. Only for CA certs.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.addnscerttosslservice.snicert"> <summary> <para type="description">Specify if the certificate will be used in SNI processing.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.addNSpolicytovpnvserver.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.addNSpolicytovpnvserver.bindpoint"> <summary> <para type="description">The bindpoint is not required when binding a session policy. It is required when bending a rewrite policy.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.removeNSpolicytovpnvserver.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.newNSurl.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.newNSurl.name"> <summary> <para type="description">The name specifies the name of the URL within the NetScaler configuration. This is not visible to end-users. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.newNSurl.linkname"> <summary> <para type="description">The linkname specifies the diplayname that users will see. Max 31 characters.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.newNSurl.actualurl"> <summary> <para type="description">Destination URL</para> </summary> </member> <member name="F:au.com.kloud.netscaler.newNSurl.vservername"> <summary> <para type="description">optional parameter to send traffic to a virtual server on the NetScaler</para> </summary> </member> <member name="F:au.com.kloud.netscaler.newNSurl.iconurl"> <summary> <para type="description">optional parameter to specify an alternative icon for the ULR.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.newNSurl.applicationtype"> <summary> <para type="description">Specify the application type. Possible values = CVPN, VPN, SaaS</para> </summary> </member> <member name="F:au.com.kloud.netscaler.newNSurl.ssotype"> <summary> <para type="description">Specify the sso type. Possible values = unifiedgateway, selfauth, samlauth</para> </summary> </member> <member name="F:au.com.kloud.netscaler.newNSurl.useproxy"> <summary> <para type="description">Specify whether or not the NetScaler is used as a reverse proxy. Default "OFF". Possible values = ON, OFF</para> </summary> </member> <member name="F:au.com.kloud.netscaler.removeNSurl.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.removeNSurl.name"> <summary> <para type="description">The name specifies the name of the URL within the NetScaler configuration. This is not visible to end-users. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.newNStheme.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.newNStheme.name"> <summary> <para type="description">Specify the name of the theme. Creates a set of folders used for this theme. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.newNStheme.basetheme"> <summary> <para type="description">New themes are based on existing themes. Specify the source (template) for this one. Ex: "RfWebUI"</para> </summary> </member> <member name="F:au.com.kloud.netscaler.removeNStheme.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.removeNStheme.name"> <summary> <para type="description">Specify the name of the theme to be deleted </para> </summary> </member> <member name="F:au.com.kloud.netscaler.newNSvpneula.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.newNSvpneula.name"> <summary> <para type="description">Specify the name of the EULA. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.removeNSvpneula.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.removeNSvpneula.name"> <summary> <para type="description">Specify the name of the EULA. </para> </summary> </member> <member name="T:au.com.kloud.netscaler.newNSvpnintranetapplication"> <summary> <para type="synopsis">The Add-NSvpnintranetapplication creates an intranet application</para> <para type="description">The add-nsvpnintranetapplication creates an intranet application which is the configuration element that controls what traffic needs to be tunneled when using split tunneling.</para> </summary> <example> <para>creating an intranet application for a subnet</para> <code>new-nsvpnintranetapplication -name "int-10.0.0.0" -mode "TRANSPARENT -protocol "ANY" -ipaddress "10.0.0.0" -netmask "255.0.0.0" </code> </example> </member> <member name="F:au.com.kloud.netscaler.newNSvpnintranetapplication.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.newNSvpnintranetapplication.name"> <summary> <para type="description">Specify the name of the intranet application. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.newNSvpnintranetapplication.iprange"> <summary> <para type="description">Specify a range of addresses Ex: "10.0.1.20-10.0.1.25", or an ip address/networkid. When using an IP address, specify the netmask. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.newNSvpnintranetapplication.returnobject"> <summary> <para type="description">If set to true, the object that is created is returned. This is useful to testing purposes.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.removeNSvpnintranetapplication.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.removeNSvpnintranetapplication.name"> <summary> <para type="description">Specify the name of the intranet application. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.addNSthemetovpnvserver.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.removeNSthemetovpnvserver.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.addNSeulatovserver.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.removeNSeulatovserver.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.addNSintranetapptovserver.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.removeNSintranetapptovserver.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="T:au.com.kloud.netscaler.addNSiiptovserver"> <summary> <para type="synopsis">The Add-NSiiptovserver command binds intranet IP addresses to a VPN vserver.</para> <para type="description">Use add-nsiiptovserver to bind intranet IP addresses to a VPN vserver. The intranet IP address range is specified by a network ID and netmask.</para> </summary> <example> <para>assigning the network 192.168.1.0/24 to the UAG-test vserver.</para> <code>add-nsiiptovserver -network "192.168.1.0" -netmask "255.255.255.0" -vserver "UAG-test"</code> </example> </member> <member name="F:au.com.kloud.netscaler.addNSiiptovserver.session"> <summary> <para type="description">This parameter requires a nitro_service object. This can be requested using the get-nitrosession.</para> </summary> </member> <member name="F:au.com.kloud.netscaler.addNSiiptovserver.network"> <summary> <para type="description">Specify the network ID for the intranet IP addresses. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.addNSiiptovserver.netmask"> <summary> <para type="description">Specify the subnet mask for the intranet IP addresses. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.addNSiiptovserver.vserver"> <summary> <para type="description">Specify the vserver this is to be associated with </para> </summary> </member> <member name="T:au.com.kloud.netscaler.RemoveNSiiptovserver"> <summary> <para type="synopsis">The remove-NSiiptovserver command unbinds intranet IP addresses from a VPN vserver.</para> <para type="description">Use remove-nsiiptovserver to unbind intranet IP addresses from a VPN vserver. The intranet IP address range is specified by a network ID and netmask.</para> </summary> <example> <para>removing the network 192.168.1.0/24 from the UAG-test vserver.</para> <code>remove-nsiiptovserver -network "192.168.1.0" -netmask "255.255.255.0" -vserver "UAG-test"</code> </example> </member> <member name="F:au.com.kloud.netscaler.RemoveNSiiptovserver.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.RemoveNSiiptovserver.network"> <summary> <para type="description">Specify the network ID for the intranet IP addresses. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.RemoveNSiiptovserver.netmask"> <summary> <para type="description">Specify the subnet mask for the intranet IP addresses. </para> </summary> </member> <member name="F:au.com.kloud.netscaler.RemoveNSiiptovserver.vserver"> <summary> <para type="description">Specify the vserver this is to be associated with </para> </summary> </member> <member name="T:pscore.netscaler.Resource.Config.Responder.Action.getNSresponderaction"> <summary> <para type="synopsis">The get-NSresponderaction fetches a responder action.</para> <para type="description">The get-NSresponderaction fetches a responder action.</para> </summary> </member> <member name="F:pscore.netscaler.Resource.Config.Responder.Action.getNSresponderaction.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:pscore.netscaler.Resource.Config.Responder.Action.getNSresponderaction.name"> <summary> <para type="description">Specify the name of the action</para> </summary> </member> <member name="T:pscore.netscaler.Resource.Config.Responder.Action.newNSresponderaction"> <summary> <para type="synopsis">The new-NSresponderaction creates a responder action.</para> <para type="description">The new-NSresponderaction creates a responder action.</para> </summary> </member> <member name="F:pscore.netscaler.Resource.Config.Responder.Action.newNSresponderaction.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:pscore.netscaler.Resource.Config.Responder.Action.newNSresponderaction.name"> <summary> <para type="description">Specify the name of the action</para> </summary> </member> <member name="F:pscore.netscaler.Resource.Config.Responder.Action.newNSresponderaction.comment"> <summary> <para type="description">Specify a comment</para> </summary> </member> <member name="F:pscore.netscaler.Resource.Config.Responder.Action.newNSresponderaction.target"> <summary> <para type="description">Expression specify what to respond with. Used with "respondwith" type. </para> </summary> </member> <member name="F:pscore.netscaler.Resource.Config.Responder.Action.newNSresponderaction.type"> <summary> <para type="description">Specify the type of action. Possible values = noop, respondwith, redirect, respondwithhtmlpage, sqlresponse_ok, sqlresponse_error </para> </summary> </member> <member name="F:pscore.netscaler.Resource.Config.Responder.Action.newNSresponderaction.responseStatusCode"> <summary> <para type="description">specify the response status code, for example "302" indicates a redirect.</para> </summary> </member> <member name="F:pscore.netscaler.Resource.Config.Responder.Action.newNSresponderaction.reasonphrase"> <summary> <para type="description">Expression specifying the reason phrase of the HTTP response. </para> </summary> </member> <member name="F:pscore.netscaler.Resource.Config.Responder.Action.newNSresponderaction.returnobject"> <summary> <para type="description">If set to true, the object that is created is returned. This is useful to testing purposes.</para> </summary> </member> <member name="T:pscore.netscaler.Resource.Config.Responder.Action.RemoveNSResponderAction"> <summary> <para type="synopsis">The get-NSresponderaction fetches a responder action.</para> <para type="description">The get-NSresponderaction fetches a responder action.</para> </summary> </member> <member name="F:pscore.netscaler.Resource.Config.Responder.Action.RemoveNSResponderAction.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="P:pscore.netscaler.Resource.Config.Responder.Action.RemoveNSResponderAction.Name"> <summary> <para type="description">Specify the name of the action</para> </summary> </member> <member name="F:pscore.netscaler.Resource.Config.Responder.Action.RemoveNSResponderAction.force"> <summary> <para type="description">If set, force deletion without confirmation.</para> </summary> </member> <member name="T:pscore.netscaler.Resource.Config.Responder.Action.setNSresponderaction"> <summary> <para type="synopsis">The get-NSresponderaction fetches a responder action.</para> <para type="description">The get-NSresponderaction fetches a responder action.</para> </summary> </member> <member name="F:pscore.netscaler.Resource.Config.Responder.Action.setNSresponderaction.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:pscore.netscaler.Resource.Config.Responder.Action.setNSresponderaction.action"> <summary> <para type="description">Specify the name of the action</para> </summary> </member> <member name="F:pscore.netscaler.Resource.Config.Responder.Action.setNSresponderaction.returnobject"> <summary> <para type="description">If set to true, the object that is created is returned. This is useful to testing purposes.</para> </summary> </member> <member name="T:pscore.netscaler.Resource.Config.Responder.policy.getNSresponderpolicy"> <summary> <para type="synopsis">The get-NSresponderpolicy fetches a responder policy.</para> <para type="description">The get-NSresponderpolicy fetches a responder policy.</para> </summary> </member> <member name="F:pscore.netscaler.Resource.Config.Responder.policy.getNSresponderpolicy.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:pscore.netscaler.Resource.Config.Responder.policy.getNSresponderpolicy.name"> <summary> <para type="description">Specify the name of the policy</para> </summary> </member> <member name="T:pscore.netscaler.Resource.Config.Responder.policy.RemoveNSResponderpolicy"> <summary> <para type="synopsis">The get-NSresponderpolicy fetches a responder policy.</para> <para type="description">The get-NSresponderpolicy fetches a responder policy.</para> </summary> </member> <member name="F:pscore.netscaler.Resource.Config.Responder.policy.RemoveNSResponderpolicy.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="P:pscore.netscaler.Resource.Config.Responder.policy.RemoveNSResponderpolicy.Name"> <summary> <para type="description">Specify the name of the policy</para> </summary> </member> <member name="F:pscore.netscaler.Resource.Config.Responder.policy.RemoveNSResponderpolicy.force"> <summary> <para type="description">If set, force deletion without confirmation.</para> </summary> </member> <member name="T:pscore.netscaler.Resource.Config.Responder.Policy.newNSresponderpolicy"> <summary> <para type="synopsis">The new-NSresponderpolicy creates a responder policy.</para> <para type="description">The new-NSresponderpolicy creates a responder policy.</para> </summary> </member> <member name="F:pscore.netscaler.Resource.Config.Responder.Policy.newNSresponderpolicy.session"> <summary> <para type="description">This mandatory parameter requires a nitro_service object. This can be requested using the get-nitrosession and pipelined into this command. </para> </summary> </member> <member name="F:pscore.netscaler.Resource.Config.Responder.Policy.newNSresponderpolicy.name"> <summary> <para type="description">Specify the name of the action</para> </summary> </member> <member name="F:pscore.netscaler.Resource.Config.Responder.Policy.newNSresponderpolicy.comment"> <summary> <para type="description">Specify a comment</para> </summary> </member> <member name="F:pscore.netscaler.Resource.Config.Responder.Policy.newNSresponderpolicy.action"> <summary> <para type="description">Action to associate with the policy </para> </summary> </member> <member name="F:pscore.netscaler.Resource.Config.Responder.Policy.newNSresponderpolicy.rule"> <summary> <para type="description">Expression for the policy</para> </summary> </member> <member name="F:pscore.netscaler.Resource.Config.Responder.Policy.newNSresponderpolicy.returnobject"> <summary> <para type="description">If set to true, the object that is created is returned. This is useful to testing purposes.</para> </summary> </member> </members> </doc> |