Add-BondedInterface WARNING: This function is deprecated. Use the following command instead: New-NetworkBondedInterface Add BondedInterface WARNING: This function is deprecated. Use the following command instead: New-NetworkBondedInterface Add-BondedInterface InterfaceID Int16 BondID Int16 LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String Add-BondedInterface InterfaceID Int16 BondID Int16 LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String InterfaceID Int16 Int16 BondID Int16 Int16 LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String AddCluster WARNING: This function is deprecated. Use the following command instead: New-GeoCluster WARNING: This function is deprecated. Use the following command instead: New-GeoCluster AddCluster ClusterIp String ClusterName String LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String AddCluster ClusterIp String ClusterName String LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String ClusterIp String String ClusterName String String LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String AddCountry WARNING: This function is deprecated. Use the following command instead: Set-GeoFQDNSiteCountry WARNING: This function is deprecated. Use the following command instead: Set-GeoFQDNSiteCountry AddCountry FQDN String SiteAddress String CountryCode String IsContinent String CustomLocation String LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String AddCountry FQDN String SiteAddress String CountryCode String IsContinent String CustomLocation String LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String FQDN String String SiteAddress String String CountryCode String String IsContinent String String CustomLocation String String LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String AddCustomLocation WARNING: This function is deprecated. Use the following command instead: New-GeoCustomLocation WARNING: This function is deprecated. Use the following command instead: New-GeoCustomLocation AddCustomLocation Location String LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String AddCustomLocation Location String LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String Location String String LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String AddFQDN WARNING: This function is deprecated. Use the following command instead: New-GeoFQDN WARNING: This function is deprecated. Use the following command instead: New-GeoFQDN AddFQDN FQDN String LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String AddFQDN FQDN String LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String FQDN String String LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String Add-GeoFQDN WARNING: This function is deprecated. Use the following command instead: New-GeoFQDN Add GeoFQDN WARNING: This function is deprecated. Use the following command instead: New-GeoFQDN Add-GeoFQDN FQDN The name of the FQDN. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Add-GeoFQDN FQDN The name of the FQDN. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String FQDN The name of the FQDN. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Add-GeoFQDN –FQDN <FQDNName> Example Output: Ok Add-InterfaceAddress WARNING: This function is deprecated. Use the following command instead: New-NetworkInterfaceAdditionalAddress Add InterfaceAddress WARNING: This function is deprecated. Use the following command instead: New-NetworkInterfaceAdditionalAddress Add-InterfaceAddress InterfaceID Int16 Address String LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String Add-InterfaceAddress InterfaceID Int16 Address String LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String InterfaceID Int16 Int16 Address String String LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String AddIP WARNING: This function is deprecated. Use the following command instead: New-GeoIpRange WARNING: This function is deprecated. Use the following command instead: New-GeoIpRange AddIP IP String LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String AddIP IP String LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String IP String String LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String AddIPCountry WARNING: This function is deprecated. Use the following command instead: Set-GeoIPRangeCountry WARNING: This function is deprecated. Use the following command instead: Set-GeoIPRangeCountry AddIPCountry IP String CountryCode String LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String AddIPCountry IP String CountryCode String LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String IP String String CountryCode String String LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String AddIPCountryCustom WARNING: This function is deprecated. Use the following command instead: Set-GeoIPRangeCustomLocation WARNING: This function is deprecated. Use the following command instead: Set-GeoIPRangeCustomLocation AddIPCountryCustom IP String CustomLoc String LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String AddIPCountryCustom IP String CustomLoc String LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String IP String String CustomLoc String String LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String AddMap WARNING: This function is deprecated. Use the following command instead: New-GeoFQDNSiteAddress WARNING: This function is deprecated. Use the following command instead: New-GeoFQDNSiteAddress AddMap FQDN String SiteAddress String Cluster String LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String AddMap FQDN String SiteAddress String Cluster String LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String FQDN String String SiteAddress String String Cluster String String LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String Add-NoCacheExtension WARNING: This function is deprecated. Use the following command instead: New-AdcHttpCacheException Add NoCacheExtension WARNING: This function is deprecated. Use the following command instead: New-AdcHttpCacheException Add-NoCacheExtension Extension String[] LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String Add-NoCacheExtension Extension String[] LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String Extension String[] String[] LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String Add-NoCompressExtension WARNING: This function is deprecated. Use the following command instead: New-AdcHttpCompressionException Add NoCompressExtension WARNING: This function is deprecated. Use the following command instead: New-AdcHttpCompressionException Add-NoCompressExtension Extension String[] LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String Add-NoCompressExtension Extension String[] LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String Extension String[] String[] LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String AddSDNController WARNING: This function is deprecated. Use the following command instead: New-SdnController WARNING: This function is deprecated. Use the following command instead: New-SdnController AddSDNController IPV4 String Port Int32 Clid Int32 Https Boolean User String Password String LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String AddSDNController IPV4 String Port Int32 Clid Int32 Https Boolean User String Password String LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String IPV4 String String Port Int32 Int32 Clid Int32 Int32 Https Boolean Boolean User String String Password String String LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String Add-VLan WARNING: This function is deprecated. Use the following command instead: New-NetworkVLAN Add VLan WARNING: This function is deprecated. Use the following command instead: New-NetworkVLAN Add-VLan InterfaceID Int16 VLanId Int16 LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String Add-VLan InterfaceID Int16 VLanId Int16 LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String InterfaceID Int16 Int16 VLanId Int16 Int16 LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String Add-VxLan WARNING: This function is deprecated. Use the following command instead: New-NetworkVxLAN Add VxLan WARNING: This function is deprecated. Use the following command instead: New-NetworkVxLAN Add-VxLan InterfaceID Int16 VNI Int32 Addr String LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String Add-VxLan InterfaceID Int16 VNI Int32 Addr String LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String InterfaceID Int16 Int16 VNI Int32 Int32 Addr String String LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String AddWafCustomData WARNING: This function is deprecated. Use the following command instead: New-WafCustomRuleData WARNING: This function is deprecated. Use the following command instead: New-WafCustomRuleData AddWafCustomData Path String LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String AddWafCustomData Path String LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String Path String String LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String AddWafCustomRule WARNING: This function is deprecated. Use the following command instead: New-WafCustomRuleSet WARNING: This function is deprecated. Use the following command instead: New-WafCustomRuleSet AddWafCustomRule Path String LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String AddWafCustomRule Path String LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String Path String String LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String AfeClientLimitAdd WARNING: This function is deprecated. Use the following command instead: New-LmIPConnectionLimit WARNING: This function is deprecated. Use the following command instead: New-LmIPConnectionLimit AfeClientLimitAdd L7addr String L7limit Int32 LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String AfeClientLimitAdd L7addr String L7limit Int32 LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String L7addr String String L7limit Int32 Int32 LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String AfeClientLimitDelete WARNING: This function is deprecated. Use the following command instead: Remove-LmIPConnectionLimit WARNING: This function is deprecated. Use the following command instead: Remove-LmIPConnectionLimit AfeClientLimitDelete L7addr String LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String AfeClientLimitDelete L7addr String LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String L7addr String String LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String AfeClientLimitList WARNING: This function is deprecated. Use the following command instead: Get-LmIPConnectionLimit WARNING: This function is deprecated. Use the following command instead: Get-LmIPConnectionLimit AfeClientLimitList LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String AfeClientLimitList LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String Backup-Certificate WARNING: This function is deprecated. Use the following command instead: Backup-TlsCertificate Backup Certificate WARNING: This function is deprecated. Use the following command instead: Backup-TlsCertificate Backup-Certificate Password String Path String LoadBalancer String LBPort Int32 Credential Object Force SwitchParameter InformationAction ActionPreference InformationVariable String Backup-Certificate Password String Path String LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String Force SwitchParameter InformationAction ActionPreference InformationVariable String Password String String Path String String LoadBalancer String String LBPort Int32 Int32 Credential Object Object Force SwitchParameter SwitchParameter InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String Backup-LmConfiguration Allows you to back up the LoadMaster. Backup LmConfiguration Allows you to back up the LoadMaster. Backup-LmConfiguration Path The local path where the LoadMaster backup file should be saved. String Force Switch to force the command to execute without a confirmation. SwitchParameter LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Backup-LmConfiguration Path The local path where the LoadMaster backup file should be saved. String Force Switch to force the command to execute without a confirmation. SwitchParameter LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String Path The local path where the LoadMaster backup file should be saved. String String Force Switch to force the command to execute without a confirmation. SwitchParameter SwitchParameter LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Backup-LmConfiguration -Path c:\backup\backup.file Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Backup-LoadBalancer WARNING: This function is deprecated. Use the following command instead: Backup-LmConfiguration Backup LoadBalancer WARNING: This function is deprecated. Use the following command instead: Backup-LmConfiguration Backup-LoadBalancer Path String Force SwitchParameter LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String Backup-LoadBalancer Path String Force SwitchParameter LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String Path String String Force SwitchParameter SwitchParameter LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String Backup-TlsCertificate Create a backup of all the certificates and intermediate certificates on the LoadMaster. Backup TlsCertificate The password will be required to restore the certificate file to the load balancer. Backup-TlsCertificate Password A password to encrypt the certificate backup file. This password will be needed to restore the certificate file to the LoadMaster. String Path The local path where the certificate backup file should be saved. If no file is specified, the backup file will be saved as C:\Temp\CertificateBackup_yyyy-MM-dd_HH-mm-ss, assuming that C:\ is the System Root drive specified in the Environment variables. If the input parameter Path is not set, the default location where the cmdlet tries to save the TlsCertificate is: $($Env:SystemRoot)\Temp If the above folder does not exist or it is not accessible (permissions) the cmdlet will fail. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Force Enable this parameter to force the command to execute without a confirmation. SwitchParameter InformationAction ActionPreference InformationVariable String Backup-TlsCertificate Password A password to encrypt the certificate backup file. This password will be needed to restore the certificate file to the LoadMaster. String Path The local path where the certificate backup file should be saved. If no file is specified, the backup file will be saved as C:\Temp\CertificateBackup_yyyy-MM-dd_HH-mm-ss, assuming that C:\ is the System Root drive specified in the Environment variables. If the input parameter Path is not set, the default location where the cmdlet tries to save the TlsCertificate is: $($Env:SystemRoot)\Temp If the above folder does not exist or it is not accessible (permissions) the cmdlet will fail. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String Force Enable this parameter to force the command to execute without a confirmation. SwitchParameter InformationAction ActionPreference InformationVariable String Password A password to encrypt the certificate backup file. This password will be needed to restore the certificate file to the LoadMaster. String String Path The local path where the certificate backup file should be saved. If no file is specified, the backup file will be saved as C:\Temp\CertificateBackup_yyyy-MM-dd_HH-mm-ss, assuming that C:\ is the System Root drive specified in the Environment variables. If the input parameter Path is not set, the default location where the cmdlet tries to save the TlsCertificate is: $($Env:SystemRoot)\Temp If the above folder does not exist or it is not accessible (permissions) the cmdlet will fail. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object Force Enable this parameter to force the command to execute without a confirmation. SwitchParameter SwitchParameter InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Backup-TlsCertificate -Password password -Path C:\temp\CertBackup_2017_04_28.16.09 Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. ChangeCheckerAddr WARNING: This function is deprecated. Use the following command instead: Set-GeoFQDNSiteCheckerAddress WARNING: This function is deprecated. Use the following command instead: Set-GeoFQDNSiteCheckerAddress ChangeCheckerAddr FQDN String SiteAddress String CheckerIP String CheckerPort String LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String ChangeCheckerAddr FQDN String SiteAddress String CheckerIP String CheckerPort String LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String FQDN String String SiteAddress String String CheckerIP String String CheckerPort String String LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String ChangeMapLocation WARNING: This function is deprecated. Use the following command instead: Set-GeoFQDNSiteCoordinates WARNING: This function is deprecated. Use the following command instead: Set-GeoFQDNSiteCoordinates ChangeMapLocation FQDN String SiteAddress String Lat Int32 Long Int32 LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String ChangeMapLocation FQDN String SiteAddress String Lat Int32 Long Int32 LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String FQDN String String SiteAddress String String Lat Int32 Int32 Long Int32 Int32 LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String Clear-SSOCache Flush the SSO authentication cache. Clear SSOCache Flush the SSO authentication cache. Clear-SSOCache LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Clear-SSOCache LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Clear-SSOCache Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. ClusterChangeLocation WARNING: This function is deprecated. Use the following command instead: Set-GeoClusterCoordinates WARNING: This function is deprecated. Use the following command instead: Set-GeoClusterCoordinates ClusterChangeLocation ClusterIp String LatSecs Int32 LongSecs Int32 LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String ClusterChangeLocation ClusterIp String LatSecs Int32 LongSecs Int32 LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String ClusterIp String String LatSecs Int32 Int32 LongSecs Int32 Int32 LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String Confirm-LicenseEULA Used to enter the magic cookie key returned by the ReadEula command to accept the EULA and to set the type of license used, for example trial, perm or free. Confirm LicenseEULA When this command is run successfully, a second EULA and magic string will be displayed. Value Description Trial Temporary license for users evaluating the KEMP LoadMaster Perm Purchased permanent LoadMaster Free Free LoadMaster Confirm-LicenseEULA Type Use this parameter to specify the type of license that is being employed. The type parameter is legacy. The default value of the type parameter is Trial. This can be overwritten by setting the type parameter when running the Confirm-LicenseEULA command. Valid values for the type parameter are: Perm - Perpetual Free - Free (Restricted) Trial – Trial (Unrestricted) String Magic The key that is is generated by the ReadEULA command. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Type Use this parameter to specify the type of license that is being employed. The type parameter is legacy. The default value of the type parameter is Trial. This can be overwritten by setting the type parameter when running the Confirm-LicenseEULA command. Valid values for the type parameter are: Perm - Perpetual Free - Free (Restricted) Trial – Trial (Unrestricted) String String Magic The key that is is generated by the ReadEULA command. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String Currently there are three license types available from KEMP. These are: Trial (Unrestricted), Perpetual and Free (Restricted). -------------------------- Example -------------------------- PS C:\> $confirm = Confirm-LicenseEULA -Magic 82745495-48f8-4fec-895c-c21f9297d989 -Type trial $confirm Example Output: Full response: @{Eula2=} Return Code..: 200 Response.....: Command successfully executed Data field...: Eula2 ----- @{MagicString=20864369-5d36-407c-874d-772e610c8bbc; Eula2=... Eula ---- @{MagicString=013b50b2-e3bb-468e-b64a-de78d46cdfb8; Eula=... Param........: MagicString Eula2 ----------- ----- 20864369-5d36-407c-874d-772e610c8bbc ... Param........: As part of KEMPs continuous drive to offer better value and services to our customers KEMP has introduced a Call Home feature. The LoadMaster can utilize Call Home to get available license updates, information regarding any updated firmware for your product and provide system status information to KEMP. The system st atus information will include Throughput, Enabled Features, Virtual Services and Real Servers details but will not include any unique personal information or actual traffic from your network. Your LoadMaster will initiate a connection to KEMP once during any 24 hour interval. <b>NOTE</b> – Allowing Call Home is mandatory for Free LoadMaster versions. For more details on this visit <a href="http://www.kemptechnologies.com/callhome" target="_blank">www.kemptechnologies.com/callhome</a> Confirm-LicenseEULA2 Specify whether or not to use the Call Home feature. Confirm LicenseEULA2 If this is enabled, the LoadMaster regularly contacts KEMP to check for updates and other information. Confirm-LicenseEULA2 Magic The IP Address for the KEMP LoadMaster to which the command is being directed. This key is generated by running the ReadEULA command. String Accept This parameter is used to accept or reject the license agreement. The possible values are; yes and no. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Magic The IP Address for the KEMP LoadMaster to which the command is being directed. This key is generated by running the ReadEULA command. String String Accept This parameter is used to accept or reject the license agreement. The possible values are; yes and no. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String -------------------------- Example -------------------------- PS C:\> $confirm = Confirm-LicenseEULA2 -Accept yes -Magic 20864369-5d36-407c-874d-772e610c8bbc $confirm Example Output: Full response: Command successfully executed Return Code..: 200 Response.....: Command successfully executed Data field...: CreateVpnConnection WARNING: This function is deprecated. Use the following command instead: New-LmVpnConnection WARNING: This function is deprecated. Use the following command instead: New-LmVpnConnection CreateVpnConnection Name String LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String CreateVpnConnection Name String LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String Name String String LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String DelCipherset WARNING: This function is deprecated. Use the following command instead: Remove-TlsCipherSet WARNING: This function is deprecated. Use the following command instead: Remove-TlsCipherSet DelCipherset Name String LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String DelCipherset Name String LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String Name String String LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String DeleteAddon WARNING: This function is deprecated. Use the following command instead: Remove-LmAddon WARNING: This function is deprecated. Use the following command instead: Remove-LmAddon DeleteAddon Name String LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String DeleteAddon Name String LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String Name String String LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String DeleteCluster WARNING: This function is deprecated. Use the following command instead: Remove-GeoCluster WARNING: This function is deprecated. Use the following command instead: Remove-GeoCluster DeleteCluster ClusterIp String LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String DeleteCluster ClusterIp String LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String ClusterIp String String LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String DeleteCustomLocation WARNING: This function is deprecated. Use the following command instead: Remove-GeoCustomLocation WARNING: This function is deprecated. Use the following command instead: Remove-GeoCustomLocation DeleteCustomLocation Location String LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String DeleteCustomLocation Location String LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String Location String String LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String DeleteFQDN WARNING: This function is deprecated. Use the following command instead: Remove-GeoFQDN WARNING: This function is deprecated. Use the following command instead: Remove-GeoFQDN DeleteFQDN FQDN String LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String DeleteFQDN FQDN String LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String FQDN String String LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String DeleteIP WARNING: This function is deprecated. Use the following command instead: Remove-GeoIpRange WARNING: This function is deprecated. Use the following command instead: Remove-GeoIpRange DeleteIP IP String LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String DeleteIP IP String LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String IP String String LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String DeleteIPLocation WARNING: This function is deprecated. Use the following command instead: Remove-GeoIPRangeCoordinates WARNING: This function is deprecated. Use the following command instead: Remove-GeoIPRangeCoordinates DeleteIPLocation IP String LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String DeleteIPLocation IP String LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String IP String String LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String DeleteMap WARNING: This function is deprecated. Use the following command instead: Remove-GeoFQDNSiteAddress WARNING: This function is deprecated. Use the following command instead: Remove-GeoFQDNSiteAddress DeleteMap FQDN String SiteAddress String LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String DeleteMap FQDN String SiteAddress String LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String FQDN String String SiteAddress String String LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String DeleteSDNController WARNING: This function is deprecated. Use the following command instead: Remove-SdnController WARNING: This function is deprecated. Use the following command instead: Remove-SdnController DeleteSDNController Clid Int32 Cid Int32 LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String DeleteSDNController Clid Int32 Cid Int32 LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String Clid Int32 Int32 Cid Int32 Int32 LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String DeleteTemplate WARNING: This function is deprecated. Use the following command instead: Remove-Template WARNING: This function is deprecated. Use the following command instead: Remove-Template DeleteTemplate Name String LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String DeleteTemplate Name String LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String Name String String LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String DeleteVpnConnection WARNING: This function is deprecated. Use the following command instead: Remove-LmVpnConnection WARNING: This function is deprecated. Use the following command instead: Remove-LmVpnConnection DeleteVpnConnection Name String LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String DeleteVpnConnection Name String LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String Name String String LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String DelWafCustomData WARNING: This function is deprecated. Use the following command instead: Uninstall-WafCustomRuleData WARNING: This function is deprecated. Use the following command instead: Uninstall-WafCustomRuleData DelWafCustomData Filename String LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String DelWafCustomData Filename String LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String Filename String String LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String DelWafCustomRule WARNING: This function is deprecated. Use the following command instead: Uninstall-WafCustomRuleSet WARNING: This function is deprecated. Use the following command instead: Uninstall-WafCustomRuleSet DelWafCustomRule Filename String LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String DelWafCustomRule Filename String LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String Filename String String LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String Disable-AdcRealServer Disables the specified Real Server. Disable AdcRealServer Disables the specified Real Server. Disable-AdcRealServer RSIpaddress The IP address of the Real Server to disable. String RSPort The port of the Real Server to disable. Int32 RSFqdn The Fully Qualified Domain Name (FQDN) of the Real Server to disable. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Disable-AdcRealServer RSIpaddress The IP address of the Real Server to disable. String RSPort The port of the Real Server to disable. Int32 RSFqdn The Fully Qualified Domain Name (FQDN) of the Real Server to disable. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String RSIpaddress The IP address of the Real Server to disable. String String RSPort The port of the Real Server to disable. Int32 Int32 RSFqdn The Fully Qualified Domain Name (FQDN) of the Real Server to disable. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String IPAddress The IP Address of the Real Server that should be disabled on the load balancer. This parameter is required. The IP address can be in either the IPv4 or IPv6 formats. string string -------------------------- Example -------------------------- PS C:\> Disable-AdcRealServer -IPAddress 10.11.0.24 Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Disable-ClusterNode Disables the specified node. Disable ClusterNode Disables the specified node. Disable-ClusterNode NodeId The ID number of the node to be disabled. The ID of the node can be found in the ID column in the Cluster Control screen in the LoadMaster WUI. Int32 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Disable-ClusterNode NodeId The ID number of the node to be disabled. The ID of the node can be found in the ID column in the Cluster Control screen in the LoadMaster WUI. Int32 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String NodeId The ID number of the node to be disabled. The ID of the node can be found in the ID column in the Cluster Control screen in the LoadMaster WUI. Int32 Int32 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Disable-ClusterNode -NodeId 2 Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. DisableGEO WARNING: This function is deprecated. Use the following command instead: Disable-LmGeoPack WARNING: This function is deprecated. Use the following command instead: Disable-LmGeoPack DisableGEO LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String DisableGEO LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String Disable-LmGeoPack Disables GEO globally for the LoadMaster. Disable LmGeoPack Disables GEO globally for the LoadMaster. Disable-LmGeoPack LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Disable-LmGeoPack LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Disable-LmGeoPack Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Disable-RealServer WARNING: This function is deprecated. Use the following command instead: Disable-AdcRealServer Disable RealServer WARNING: This function is deprecated. Use the following command instead: Disable-AdcRealServer Disable-RealServer RSIpaddress String RSPort Int32 RSFqdn String LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String Disable-RealServer RSIpaddress String RSPort Int32 RSFqdn String LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String RSIpaddress String String RSPort Int32 Int32 RSFqdn String String LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String Disable-SecAPIAccess Disables the programmable Application Program Interface (API). Disable SecAPIAccess Run this command to disable the API interface. Disable-SecAPIAccess LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Disable-SecAPIAccess LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String If this is disabled, the API will no longer be accessible. -------------------------- Example -------------------------- PS C:\> Disable-SecAPIAccess Example Output: Full response: @{ReturnCode=200; Response=The API is disabled; Data=} Return Code..: 200 Response.....: The API is disabled DisableWafRemoteLogging WARNING: This function is deprecated. Use the following command instead: Disable-WafRemoteLogging WARNING: This function is deprecated. Use the following command instead: Disable-WafRemoteLogging DisableWafRemoteLogging LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String DisableWafRemoteLogging LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String Disable-WafRemoteLogging Allows you to turn off WAF remote logging. Disable WafRemoteLogging Allows you to turn off WAF remote logging. Disable-WafRemoteLogging LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Disable-WafRemoteLogging LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Disable-WafRemoteLogging -LoadBalancer <LoadMasterIPAddress> Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. DoTcpDump WARNING: This function is deprecated. Use the following command instead: Trace-TcpTraffic WARNING: This function is deprecated. Use the following command instead: Trace-TcpTraffic DoTcpDump MaxPackets The maximum number of packets to capture. The default value for this parameter is 10000. Valid values range from 1 to 200000. The maximum is the API maximum. The actual maximum size is defined by the space available. Int32 MaxTime The maximum number of seconds to capture. The default value for this parameter is 10. Valid values range from 1 to 600. Int32 Interface The interface(s) to monitor. The default interface is eth0. A TCP dump can be captured either by one or all Ethernet ports. String Port The port to be monitored. String Address The (optional) address to be monitored. String TcpOptions Any additional TCPDump parameters needed. The maximum number of characters permitted is 255. String Path The path to export a saved file to. If the path parameter is not populated, the path defaults to <WindowsDirectory>\Temp\tcpdump_<Timestamp>.pcap. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Force SwitchParameter InformationAction ActionPreference InformationVariable String WhatIf SwitchParameter Confirm SwitchParameter DoTcpDump MaxPackets The maximum number of packets to capture. The default value for this parameter is 10000. Valid values range from 1 to 200000. The maximum is the API maximum. The actual maximum size is defined by the space available. Int32 MaxTime The maximum number of seconds to capture. The default value for this parameter is 10. Valid values range from 1 to 600. Int32 Interface The interface(s) to monitor. The default interface is eth0. A TCP dump can be captured either by one or all Ethernet ports. String Port The port to be monitored. String Address The (optional) address to be monitored. String TcpOptions Any additional TCPDump parameters needed. The maximum number of characters permitted is 255. String Path The path to export a saved file to. If the path parameter is not populated, the path defaults to <WindowsDirectory>\Temp\tcpdump_<Timestamp>.pcap. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String Force SwitchParameter InformationAction ActionPreference InformationVariable String WhatIf SwitchParameter Confirm SwitchParameter MaxPackets The maximum number of packets to capture. The default value for this parameter is 10000. Valid values range from 1 to 200000. The maximum is the API maximum. The actual maximum size is defined by the space available. Int32 Int32 MaxTime The maximum number of seconds to capture. The default value for this parameter is 10. Valid values range from 1 to 600. Int32 Int32 Interface The interface(s) to monitor. The default interface is eth0. A TCP dump can be captured either by one or all Ethernet ports. String String Port The port to be monitored. String String Address The (optional) address to be monitored. String String TcpOptions Any additional TCPDump parameters needed. The maximum number of characters permitted is 255. String String Path The path to export a saved file to. If the path parameter is not populated, the path defaults to <WindowsDirectory>\Temp\tcpdump_<Timestamp>.pcap. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object Force SwitchParameter SwitchParameter InformationAction ActionPreference ActionPreference InformationVariable String String WhatIf SwitchParameter SwitchParameter Confirm SwitchParameter SwitchParameter CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> DoTcpDump -MaxPackets 15000 -Interface any -Port 443 -MaxTime 800 -Path c:\temp\out.pcap Example Output: No output is displayed, but a file will be downloaded to the specified path. DownloadWafAuditLog WARNING: This function is deprecated. Use the following command instead: Export-WafAuditLog WARNING: This function is deprecated. Use the following command instead: Export-WafAuditLog DownloadWafAuditLog Path String AuditFile String Filter String LoadBalancer String LBPort Int32 Credential Object Force SwitchParameter InformationAction ActionPreference InformationVariable String DownloadWafAuditLog Path String AuditFile String Filter String LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String Force SwitchParameter InformationAction ActionPreference InformationVariable String Path String String AuditFile String String Filter String String LoadBalancer String String LBPort Int32 Int32 Credential Object Object Force SwitchParameter SwitchParameter InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String DownloadWafCustomData WARNING: This function is deprecated. Use the following command instead: Export-WafCustomRuleData WARNING: This function is deprecated. Use the following command instead: Export-WafCustomRuleData DownloadWafCustomData Path String RuleDataName String LoadBalancer String LBPort Int32 Credential Object Force SwitchParameter InformationAction ActionPreference InformationVariable String DownloadWafCustomData Path String RuleDataName String LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String Force SwitchParameter InformationAction ActionPreference InformationVariable String Path String String RuleDataName String String LoadBalancer String String LBPort Int32 Int32 Credential Object Object Force SwitchParameter SwitchParameter InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String DownloadWafCustomRule WARNING: This function is deprecated. Use the following command instead: Export-WafCustomRuleSet WARNING: This function is deprecated. Use the following command instead: Export-WafCustomRuleSet DownloadWafCustomRule Path String RuleSetName String LoadBalancer String LBPort Int32 Credential Object Force SwitchParameter InformationAction ActionPreference InformationVariable String DownloadWafCustomRule Path String RuleSetName String LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String Force SwitchParameter InformationAction ActionPreference InformationVariable String Path String String RuleSetName String String LoadBalancer String String LBPort Int32 Int32 Credential Object Object Force SwitchParameter SwitchParameter InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String DownloadWafRules WARNING: This function is deprecated. Use the following command instead: Update-WafRulesDatabase WARNING: This function is deprecated. Use the following command instead: Update-WafRulesDatabase DownloadWafRules LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String DownloadWafRules LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String An error might be displayed, for example Command Failed: Download Failed if there is a problem downloading the rules. If there are no updates because the latest rules have already been downloaded, a message will be displayed which says No updates available. -------------------------- Example -------------------------- PS C:\> DownloadWafRules Example Output: Ok EditCustomLocation WARNING: This function is deprecated. Use the following command instead: Set-GeoCustomLocation WARNING: This function is deprecated. Use the following command instead: Set-GeoCustomLocation EditCustomLocation clOldName String clNewName String LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String EditCustomLocation clOldName String clNewName String LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String clOldName String String clNewName String String LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String Enable-AdcRealServer Enables a specified Real Server that is currently disabled. Enable AdcRealServer Enables a specified Real Server that is currently disabled. Enable-AdcRealServer RSIpAddress The IP address of the Real Server to enable. String RSPort The port of the Real Server to enable. Int32 RSFqdn The Fully Qualified Domain Name (FQDN) of the Real Server to enable. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Enable-AdcRealServer RSIpAddress The IP address of the Real Server to enable. String RSPort The port of the Real Server to enable. Int32 RSFqdn The Fully Qualified Domain Name (FQDN) of the Real Server to enable. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String RSIpAddress The IP address of the Real Server to enable. String String RSPort The port of the Real Server to enable. Int32 Int32 RSFqdn The Fully Qualified Domain Name (FQDN) of the Real Server to enable. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String IPAddress The IP Address of the Real Server that should be enabled on the load balancer. This parameter is required. The IP address can be in either the IPv4 (e.g. 10.11.0.24) or IPv6 (e.g. fdce:9b36:e54f:110::40:14) format. string string -------------------------- Example -------------------------- PS C:\> Enable-AdcRealServer -RSIpAddress 10.154.11.84 Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Data field...: @{Rs=} Param........: @{Status=Down; VSIndex=1; RsIndex=4; Addr=10.154.11.84; Port=443; DnsName=; Forward=route; Weight=1000; Limit=0; Follow=0; Enable=Y; Crit ical=N} Enable-ClusterNode Enables the specified node. Enable ClusterNode Enables the specified node. Enable-ClusterNode NodeId The ID number of the node to be enabled. The ID of the node can be found in the ID column in the Cluster Control screen in the LoadMaster WUI. Int32 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Enable-ClusterNode NodeId The ID number of the node to be enabled. The ID of the node can be found in the ID column in the Cluster Control screen in the LoadMaster WUI. Int32 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String NodeId The ID number of the node to be enabled. The ID of the node can be found in the ID column in the Cluster Control screen in the LoadMaster WUI. Int32 Int32 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Enable-ClusterNode -NodeId 2 Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. EnableGEO WARNING: This function is deprecated. Use the following command instead: Enable-LmGeoPack WARNING: This function is deprecated. Use the following command instead: Enable-LmGeoPack EnableGEO LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String EnableGEO LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String Enable-LmGeoPack Enables GEO globally for the LoadMaster. Enable LmGeoPack Enables GEO globally for the LoadMaster. Enable-LmGeoPack LoadBalancer The IP address of the KEMP LoadMaster that you are directing the command to. This can be set globally by using the Initialize-LoadBalancer command, but can be overridden on each individual command by using this parameter. String LBPort The port of the load balancer. Int32 Credential Specifies a user account that has permission to administer the load balancer. You can either enter a username for the load balancer or provide a PSCredential object, such as an object that is returned by the Get-Credential cmdlet. When you type a username, you are prompted for a password. Object InformationAction ActionPreference InformationVariable String Enable-LmGeoPack LoadBalancer The IP address of the KEMP LoadMaster that you are directing the command to. This can be set globally by using the Initialize-LoadBalancer command, but can be overridden on each individual command by using this parameter. String LBPort The port of the load balancer. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. String InformationAction ActionPreference InformationVariable String LoadBalancer The IP address of the KEMP LoadMaster that you are directing the command to. This can be set globally by using the Initialize-LoadBalancer command, but can be overridden on each individual command by using this parameter. String String LBPort The port of the load balancer. Int32 Int32 Credential Specifies a user account that has permission to administer the load balancer. You can either enter a username for the load balancer or provide a PSCredential object, such as an object that is returned by the Get-Credential cmdlet. When you type a username, you are prompted for a password. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. String String -------------------------- Example -------------------------- PS C:\> Enable-LmGeoPack Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Enable-RealServer WARNING: This function is deprecated. Use the following command instead: Enable-AdcRealServer Enable RealServer WARNING: This function is deprecated. Use the following command instead: Enable-AdcRealServer Enable-RealServer RSIpAddress String RSPort Int32 RSFqdn String LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String Enable-RealServer RSIpAddress String RSPort Int32 RSFqdn String LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String RSIpAddress String String RSPort Int32 Int32 RSFqdn String String LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String Enable-SecAPIAccess Enables the programmable Application Program Interface (API). Enable SecAPIAccess Run this command to enable the API interface. Enable-SecAPIAccess LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Enable-SecAPIAccess LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Enable-SecAPIAccess ReturnCode Response Data ---------- -------- ---- 200 The API is enabled EnableWafRemoteLogging WARNING: This function is deprecated. Use the following command instead: Enable-WafRemoteLogging WARNING: This function is deprecated. Use the following command instead: Enable-WafRemoteLogging EnableWafRemoteLogging RemoteURI String Username String Passwd String LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String EnableWafRemoteLogging RemoteURI String Username String Passwd String LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String RemoteURI String String Username String String Passwd String String LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String Enable-WafRemoteLogging Allows you to enable WAF remote logging. Enable WafRemoteLogging Allows you to enable WAF remote logging. Enable-WafRemoteLogging RemoteURI The remote server console URI. String Username The remote username. String Passwd The remote password. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Enable-WafRemoteLogging RemoteURI The remote server console URI. String Username The remote username. String Passwd The remote password. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String RemoteURI The remote server console URI. String String Username The remote username. String String Passwd The remote password. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Enable-WafRemoteLogging -Passwd ExamplePassword -RemoteURI ExampleRemoteURI -Username ExampleUsername Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Export-GeoIPBlacklistDatabase Retrieve the GEO IP blacklist. Export GeoIPBlacklistDatabase Run this command to display the current, full GEO IP blacklist. Export-GeoIPBlacklistDatabase filename This parameter is mandatory. This is the desired path and filename for the file that will be downloaded from the LoadMaster. If a file with the same name already exists, the command will fail. If no data is available on the LoadMaster, the command returns an empty file. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Force Enable this parameter to force the command to execute without a confirmation. SwitchParameter InformationAction ActionPreference InformationVariable String Export-GeoIPBlacklistDatabase filename This parameter is mandatory. This is the desired path and filename for the file that will be downloaded from the LoadMaster. If a file with the same name already exists, the command will fail. If no data is available on the LoadMaster, the command returns an empty file. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String Force Enable this parameter to force the command to execute without a confirmation. SwitchParameter InformationAction ActionPreference InformationVariable String filename This parameter is mandatory. This is the desired path and filename for the file that will be downloaded from the LoadMaster. If a file with the same name already exists, the command will fail. If no data is available on the LoadMaster, the command returns an empty file. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object Force Enable this parameter to force the command to execute without a confirmation. SwitchParameter SwitchParameter InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Export-GeoIPBlacklistDatabase -filename 'C:\Users\ExampleUser\Documents\temp\blacklist.txt' Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Export-GeoIPBlacklistDatabaseChanges Retrieve a list of changes which were made to the blacklist. Export GeoIPBlacklistDatabaseChanges To retrieve a list of changes which were made as of the last download, run this command. Export-GeoIPBlacklistDatabaseChanges filename This parameter is mandatory. This is the desired path and filename for the file that will be downloaded from the LoadMaster. If a file with the same name already exists, the command will fail. If no data is available on the LoadMaster, the command returns an empty file. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Force Enable this parameter to force the command to execute without a confirmation. SwitchParameter InformationAction ActionPreference InformationVariable String Export-GeoIPBlacklistDatabaseChanges filename This parameter is mandatory. This is the desired path and filename for the file that will be downloaded from the LoadMaster. If a file with the same name already exists, the command will fail. If no data is available on the LoadMaster, the command returns an empty file. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String Force Enable this parameter to force the command to execute without a confirmation. SwitchParameter InformationAction ActionPreference InformationVariable String filename This parameter is mandatory. This is the desired path and filename for the file that will be downloaded from the LoadMaster. If a file with the same name already exists, the command will fail. If no data is available on the LoadMaster, the command returns an empty file. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object Force Enable this parameter to force the command to execute without a confirmation. SwitchParameter SwitchParameter InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Export-GeoIPBlacklistDatabaseChanges -filename c:\t\example Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Export-GeoIPWhitelistDatabase Retrieve the contents of the user-defined whitelist. Export GeoIPWhitelistDatabase To view the user-defined whitelist (which overrides the blacklist), run this command. Export-GeoIPWhitelistDatabase filename This parameter is mandatory. This is the desired path and filename for the file that will be downloaded from the LoadMaster. If a file with the same name already exists, the command will fail. If no data is available on the LoadMaster, the command returns an empty file. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Force Enable this parameter to force the command to execute without a confirmation. SwitchParameter InformationAction ActionPreference InformationVariable String Export-GeoIPWhitelistDatabase filename This parameter is mandatory. This is the desired path and filename for the file that will be downloaded from the LoadMaster. If a file with the same name already exists, the command will fail. If no data is available on the LoadMaster, the command returns an empty file. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String Force Enable this parameter to force the command to execute without a confirmation. SwitchParameter InformationAction ActionPreference InformationVariable String filename This parameter is mandatory. This is the desired path and filename for the file that will be downloaded from the LoadMaster. If a file with the same name already exists, the command will fail. If no data is available on the LoadMaster, the command returns an empty file. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object Force Enable this parameter to force the command to execute without a confirmation. SwitchParameter SwitchParameter InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Export-GeoIPWhitelistDatabase -filename c:\t\example3 Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Export-SAMLSPCert If using a self-signed certificate, the Export-SAMLSPCert command is used to download the certificate from the LoadMaster. Export SAMLSPCert This certificate must be installed on the IdP server (for example AD FS) in order to be added to the relying party signature. The AD FS server will require this certificate for use of the public key in order to verify the signatures that the LoadMaster generates. Export-SAMLSPCert Domain The name of the relevant SAML SSO domain to download the certificate for. String CertificateFilePath The CertificateFilePath parameter of the Export-SAMLSPCert is the name of the file where to store the certificate, not a path. The name can be with or without the path. If no path is provided, the file is stored in current working directory. If the file is already present the command fails. To overwrite it, the Force switch must be used. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Force Enable this parameter to force the command to execute without a confirmation SwitchParameter InformationAction ActionPreference InformationVariable String WhatIf Enable this parameter to see what the command will do without actually executing the command. SwitchParameter Confirm Confirms that the action should be carried out. SwitchParameter Export-SAMLSPCert Domain The name of the relevant SAML SSO domain to download the certificate for. String CertificateFilePath The CertificateFilePath parameter of the Export-SAMLSPCert is the name of the file where to store the certificate, not a path. The name can be with or without the path. If no path is provided, the file is stored in current working directory. If the file is already present the command fails. To overwrite it, the Force switch must be used. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String Force Enable this parameter to force the command to execute without a confirmation SwitchParameter InformationAction ActionPreference InformationVariable String WhatIf Enable this parameter to see what the command will do without actually executing the command. SwitchParameter Confirm Confirms that the action should be carried out. SwitchParameter Domain The name of the relevant SAML SSO domain to download the certificate for. String String CertificateFilePath The CertificateFilePath parameter of the Export-SAMLSPCert is the name of the file where to store the certificate, not a path. The name can be with or without the path. If no path is provided, the file is stored in current working directory. If the file is already present the command fails. To overwrite it, the Force switch must be used. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object Force Enable this parameter to force the command to execute without a confirmation SwitchParameter SwitchParameter InformationAction ActionPreference ActionPreference InformationVariable String String WhatIf Enable this parameter to see what the command will do without actually executing the command. SwitchParameter SwitchParameter Confirm Confirms that the action should be carried out. SwitchParameter SwitchParameter CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Export-SAMLSPCert -CertificateFilePath C:\ExamplePath\SAMLCert -Domain example.com Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Export-SecUserCertificate Download a previously generated local user certificate. Export SecUserCertificate Download a previously generated local user certificate. Export-SecUserCertificate User The relevant username to download the certificate for. String Path The location to store the certificate file in. String Force Enable this parameter to force the command to execute without a confirmation. SwitchParameter LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Export-SecUserCertificate User The relevant username to download the certificate for. String Path The location to store the certificate file in. String Force Enable this parameter to force the command to execute without a confirmation. SwitchParameter LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String User The relevant username to download the certificate for. String String Path The location to store the certificate file in. String String Force Enable this parameter to force the command to execute without a confirmation. SwitchParameter SwitchParameter LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Export-KEMPSecUserCertificate -Path c:\temp\cert -User Example Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. ExportVSTemplate WARNING: This function is deprecated. Use the following command instead: Export-VSTemplate WARNING: This function is deprecated. Use the following command instead: Export-VSTemplate ExportVSTemplate VirtualService Specify the IP address of the Virtual Service to be exported as a template. String Port Specifies the port on which this Virtual Service accepts connections. Int32 Protocol Specifies the communication protocol of the Virtual Service. Valid options are TCP or UDP. String VSIndex Int32 Path The path to the location to download the template file to, followed by the desired template file name, in the format <Path>\<Filename>.txt. String Force SwitchParameter LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String ExportVSTemplate VirtualService Specify the IP address of the Virtual Service to be exported as a template. String Port Specifies the port on which this Virtual Service accepts connections. Int32 Protocol Specifies the communication protocol of the Virtual Service. Valid options are TCP or UDP. String VSIndex Int32 Path The path to the location to download the template file to, followed by the desired template file name, in the format <Path>\<Filename>.txt. String Force SwitchParameter LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String VirtualService Specify the IP address of the Virtual Service to be exported as a template. String String Port Specifies the port on which this Virtual Service accepts connections. Int32 Int32 Protocol Specifies the communication protocol of the Virtual Service. Valid options are TCP or UDP. String String VSIndex Int32 Int32 Path The path to the location to download the template file to, followed by the desired template file name, in the format <Path>\<Filename>.txt. String String Force SwitchParameter SwitchParameter LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> ExportVSTemplate -Path C:\Temp\ExampleTemplateName.txt -Port 80 -Protocol tcp -VirtualService 172.20.0.234 Example Output: No output is displayed, but the file should be downloaded to the specified location. Export-VSTemplate Export a Virtual Service as a template. Export VSTemplate Export the settings in a Virtual Service as a template that can be used to create other Virtual Services. Export-VSTemplate VirtualService The IP address of the Virtual Service to export. String Port The port of the Virtual Service to export. Int32 Protocol The protocol of the Virtual Service to export. String VSIndex The index number of the Virtual Service to export. Int32 Path The location to save the exported template to, in the format <path>\<filename>. String Force Enable this parameter to force the command to execute without a confirmation. SwitchParameter LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Export-VSTemplate VirtualService The IP address of the Virtual Service to export. String Port The port of the Virtual Service to export. Int32 Protocol The protocol of the Virtual Service to export. String VSIndex The index number of the Virtual Service to export. Int32 Path The location to save the exported template to, in the format <path>\<filename>. String Force Enable this parameter to force the command to execute without a confirmation. SwitchParameter LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String VirtualService The IP address of the Virtual Service to export. String String Port The port of the Virtual Service to export. Int32 Int32 Protocol The protocol of the Virtual Service to export. String String VSIndex The index number of the Virtual Service to export. Int32 Int32 Path The location to save the exported template to, in the format <path>\<filename>. String String Force Enable this parameter to force the command to execute without a confirmation. SwitchParameter SwitchParameter LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Export-VSTemplate -Path C:\t\template -Port 443 -Protocol tcp -VirtualService 10.154.11.181 Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Export-WafAuditLog Allows you to download the AFP audit logs. Export WafAuditLog Allows you to download the AFP audit logs. Export-WafAuditLog Path Path to where you want to download the AFP audit logs to. You can either specify a path or a path and filename. If the parameter Path does not contain a filename but only a path and the AuditFile parameter is not null, path will be set to the value path/filename. If you do not specify a path, the default path is $Env:SystemRoot\Temp\wafaudit_$(Get-Date -format yyyy-MM-dd_HH-mm-ss).log. Usually the $Env:SystemRoot is C:\Windows. Note that the C:\Windows\Temp must exist and the user must have write access to it in order to save the file in that folder. If not the cmdlet will fail. String AuditFile The name of the WAF audit log file to be downloaded, for example wafaudit.1. String Filter The filter string. This can be a regular expression. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Force Enable this parameter to force the command to execute without a confirmation. SwitchParameter InformationAction ActionPreference InformationVariable String Export-WafAuditLog Path Path to where you want to download the AFP audit logs to. You can either specify a path or a path and filename. If the parameter Path does not contain a filename but only a path and the AuditFile parameter is not null, path will be set to the value path/filename. If you do not specify a path, the default path is $Env:SystemRoot\Temp\wafaudit_$(Get-Date -format yyyy-MM-dd_HH-mm-ss).log. Usually the $Env:SystemRoot is C:\Windows. Note that the C:\Windows\Temp must exist and the user must have write access to it in order to save the file in that folder. If not the cmdlet will fail. String AuditFile The name of the WAF audit log file to be downloaded, for example wafaudit.1. String Filter The filter string. This can be a regular expression. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String Force Enable this parameter to force the command to execute without a confirmation. SwitchParameter InformationAction ActionPreference InformationVariable String Path Path to where you want to download the AFP audit logs to. You can either specify a path or a path and filename. If the parameter Path does not contain a filename but only a path and the AuditFile parameter is not null, path will be set to the value path/filename. If you do not specify a path, the default path is $Env:SystemRoot\Temp\wafaudit_$(Get-Date -format yyyy-MM-dd_HH-mm-ss).log. Usually the $Env:SystemRoot is C:\Windows. Note that the C:\Windows\Temp must exist and the user must have write access to it in order to save the file in that folder. If not the cmdlet will fail. String String AuditFile The name of the WAF audit log file to be downloaded, for example wafaudit.1. String String Filter The filter string. This can be a regular expression. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object Force Enable this parameter to force the command to execute without a confirmation. SwitchParameter SwitchParameter InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String The AFP logs are not generated in real time – they can be up to two minutes behind what the AFP engine is actually processing. -------------------------- Example -------------------------- PS C:\> Export-WafAuditLog -Path C:\WAFLogs\ExampleDesiredFileName -File wafaudit.1 Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Export-WafChangeLog Used to download a log file containing changes made to the KEMP Technologies Web Application Firewall (WAF) rule set. Export WafChangeLog Used to download a log file containing changes made to the KEMP Technologies Web Application Firewall (WAF) rule set. Export-WafChangeLog Path The path to download the change log file to, followed by the filename and extension, in the format <Path\Filename.Extension>. If you do not specify a path, the default path is $Env:SystemRoot\Temp\WAF_changes_$(Get-Date -format yyyy-MM-dd_HH-mm-ss).log. Usually the $Env:SystemRoot is C:\Windows. Note that the C:\Windows\Temp must exist and the user must have write access to it in order to save the file in that folder. If not the cmdlet will fail. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Force Enable this parameter to force the command to execute without a confirmation. SwitchParameter InformationAction ActionPreference InformationVariable String Export-WafChangeLog Path The path to download the change log file to, followed by the filename and extension, in the format <Path\Filename.Extension>. If you do not specify a path, the default path is $Env:SystemRoot\Temp\WAF_changes_$(Get-Date -format yyyy-MM-dd_HH-mm-ss).log. Usually the $Env:SystemRoot is C:\Windows. Note that the C:\Windows\Temp must exist and the user must have write access to it in order to save the file in that folder. If not the cmdlet will fail. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String Force Enable this parameter to force the command to execute without a confirmation. SwitchParameter InformationAction ActionPreference InformationVariable String Path The path to download the change log file to, followed by the filename and extension, in the format <Path\Filename.Extension>. If you do not specify a path, the default path is $Env:SystemRoot\Temp\WAF_changes_$(Get-Date -format yyyy-MM-dd_HH-mm-ss).log. Usually the $Env:SystemRoot is C:\Windows. Note that the C:\Windows\Temp must exist and the user must have write access to it in order to save the file in that folder. If not the cmdlet will fail. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object Force Enable this parameter to force the command to execute without a confirmation. SwitchParameter SwitchParameter InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Export-WafChangeLog -Path C:\WAFLogs\ExampleFileName.log Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Export-WafCustomRuleData Allows you to download an AFP custom rule data file to your local machine. Export WafCustomRuleData Allows you to download an AFP custom rule data file to your local machine. Export-WafCustomRuleData Path The path to download the file to. You can either specify a path or a path and filename. If the parameter Path does not contain a filename but only a path and the RuleDataName parameter is not null, the path will be set to the value path/RuleDataName. If you do not specify a path, the default path is $Env:SystemRoot\Temp\WafCustomRuleData_$(Get-Date -format yyyy-MM-dd_HH-mm-ss). Usually the $Env:SystemRoot is C:\Windows. Note that the C:\Windows\Temp must exist and the user must have write access to it in order to save the file in that folder. If not the cmdlet will fail. String RuleDataName The filename of the custom rule data file, followed by the extension (.data). String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Force Switch to force the command to execute without a confirmation. SwitchParameter InformationAction ActionPreference InformationVariable String Export-WafCustomRuleData Path The path to download the file to. You can either specify a path or a path and filename. If the parameter Path does not contain a filename but only a path and the RuleDataName parameter is not null, the path will be set to the value path/RuleDataName. If you do not specify a path, the default path is $Env:SystemRoot\Temp\WafCustomRuleData_$(Get-Date -format yyyy-MM-dd_HH-mm-ss). Usually the $Env:SystemRoot is C:\Windows. Note that the C:\Windows\Temp must exist and the user must have write access to it in order to save the file in that folder. If not the cmdlet will fail. String RuleDataName The filename of the custom rule data file, followed by the extension (.data). String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String Force Switch to force the command to execute without a confirmation. SwitchParameter InformationAction ActionPreference InformationVariable String Path The path to download the file to. You can either specify a path or a path and filename. If the parameter Path does not contain a filename but only a path and the RuleDataName parameter is not null, the path will be set to the value path/RuleDataName. If you do not specify a path, the default path is $Env:SystemRoot\Temp\WafCustomRuleData_$(Get-Date -format yyyy-MM-dd_HH-mm-ss). Usually the $Env:SystemRoot is C:\Windows. Note that the C:\Windows\Temp must exist and the user must have write access to it in order to save the file in that folder. If not the cmdlet will fail. String String RuleDataName The filename of the custom rule data file, followed by the extension (.data). String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object Force Switch to force the command to execute without a confirmation. SwitchParameter SwitchParameter InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Export-WafCustomRuleData -Filename modsecurity_35_bad_robots -Path C:\rules\badrobots1 Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Export-WafCustomRuleSet Download a Web Application Firewall (WAF) custom rule file. Export WafCustomRuleSet Download the specified rule file to the specified path. Export-WafCustomRuleSet Path The path to download the file to. You can either specify a path or a path and filename. If the parameter Path does not contain a filename but only a path and the RuleDataName parameter is not null, the path will be set to the value path/RuleDataName. If you do not specify a path, the default path is $Env:SystemRoot\Temp\WafCustomRuleSet_$(Get-Date -format yyyy-MM-dd_HH-mm-ss). Usually the $Env:SystemRoot is C:\Windows. Note that the C:\Windows\Temp must exist and the user must have write access to it in order to save the file in that folder. If not the cmdlet will fail. String RuleSetName The filename of the custom rule. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Force Switch to force the command to execute without a confirmation. SwitchParameter InformationAction ActionPreference InformationVariable String Export-WafCustomRuleSet Path The path to download the file to. You can either specify a path or a path and filename. If the parameter Path does not contain a filename but only a path and the RuleDataName parameter is not null, the path will be set to the value path/RuleDataName. If you do not specify a path, the default path is $Env:SystemRoot\Temp\WafCustomRuleSet_$(Get-Date -format yyyy-MM-dd_HH-mm-ss). Usually the $Env:SystemRoot is C:\Windows. Note that the C:\Windows\Temp must exist and the user must have write access to it in order to save the file in that folder. If not the cmdlet will fail. String RuleSetName The filename of the custom rule. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String Force Switch to force the command to execute without a confirmation. SwitchParameter InformationAction ActionPreference InformationVariable String Path The path to download the file to. You can either specify a path or a path and filename. If the parameter Path does not contain a filename but only a path and the RuleDataName parameter is not null, the path will be set to the value path/RuleDataName. If you do not specify a path, the default path is $Env:SystemRoot\Temp\WafCustomRuleSet_$(Get-Date -format yyyy-MM-dd_HH-mm-ss). Usually the $Env:SystemRoot is C:\Windows. Note that the C:\Windows\Temp must exist and the user must have write access to it in order to save the file in that folder. If not the cmdlet will fail. String String RuleSetName The filename of the custom rule. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object Force Switch to force the command to execute without a confirmation. SwitchParameter SwitchParameter InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Export-WafCustomRuleSet -Filename modsecurity_crs_40_generic_attacks -Path C:\t\ExportedRule Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. FlushSsoCache WARNING: This function is deprecated. Use the following command instead: Clear-SSOCache WARNING: This function is deprecated. Use the following command instead: Clear-SSOCache FlushSsoCache LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String FlushSsoCache LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String Get-AdaptiveCheck WARNING: This function is deprecated. Use the following command instead: Get-AdcAdaptiveHealthCheck Get AdaptiveCheck WARNING: This function is deprecated. Use the following command instead: Get-AdcAdaptiveHealthCheck Get-AdaptiveCheck LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String Get-AdaptiveCheck LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String Get-AdcAdaptiveHealthCheck Allows you to view the values of the Adaptive Health Checking options. Get AdcAdaptiveHealthCheck Allows you to view the values of the Adaptive Health Checking options. Get-AdcAdaptiveHealthCheck LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Get-AdcAdaptiveHealthCheck LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Get-AdcAdaptiveHealthCheck Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. AdaptiveURL : /load AdaptivePort : 80 AdaptiveInterval : 7 MinPercent : 5 Get-AdcContentRule Returns configured rules on the LoadMaster and the values of the associated options. Get AdcContentRule Returns configured rules on the LoadMaster and the values of the associated options. You can specify all the configured rules, a specific rule or rules of a specific type. Get-AdcContentRule RuleName Specifies the name of the rule to retrieve. String RuleType Specifies the type of rule to retrieve from the LoadMaster. Options are: - MatchContentRule - AddHeaderRule - DeleteHeaderRule - ReplaceHeaderRule - ModifyURLRule String All Gets all rules defined on the LoadMaster. SwitchParameter LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Get-AdcContentRule RuleName Specifies the name of the rule to retrieve. String RuleType Specifies the type of rule to retrieve from the LoadMaster. Options are: - MatchContentRule - AddHeaderRule - DeleteHeaderRule - ReplaceHeaderRule - ModifyURLRule String All Gets all rules defined on the LoadMaster. SwitchParameter LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String RuleName Specifies the name of the rule to retrieve. String String RuleType Specifies the type of rule to retrieve from the LoadMaster. Options are: - MatchContentRule - AddHeaderRule - DeleteHeaderRule - ReplaceHeaderRule - ModifyURLRule String String All Gets all rules defined on the LoadMaster. SwitchParameter SwitchParameter LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Get-AdcContentRule -Type MatchContentRule Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Data field...: @{ContentRules=} Param........: @{MatchContentRule=} MatchContentRule : @{Name=Example3; Pattern=ExamplePattern2; MatchType=Regex; AddHost=N; Negate=N; CaseIndependent=N; IncludeQuery=N; Header=; MustFail=N} Get-AdcL7Configuration Allows you to view the values of Layer 7 Configuration options. Get AdcL7Configuration Allows you to view the values of Layer 7 Configuration options. Get-AdcL7Configuration LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Get-AdcL7Configuration LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Get-AdcL7Configuration -LoadBalancer 172.21.59.189 -LBPort 8443 Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed; Data=} Return Code..: 200 Response.....: Command successfully executed Data field...: @{AdcL7Configuration=} Param........: @{ScalingOver64KConnections=no; AlwaysCheckPersist=Yes - Accept Changes; AddPortToActiveCookie=no; RFCConform=yes; CloseOnError=no; AddVi aHeaderInCacheResponses=no; RSAreLocal=no; DropOnRSFail=no; DropAtDrainEnd=no; L7AuthTimeoutSecs=30; L7ClientTokenTimeoutSecs=120; L7ConnectionDrainTime outSecs=300; AdditionalL7Header=X-ClientSide; OneHundredContinueHandling=RFC-2616 Compliant; AllowEmptyPosts=no; AllowEmptyHttpHeaders=no; ForceComplete RSMatch=no; SlowStart=0; ShareSubVSPersistance=no} ScalingOver64KConnections : no AlwaysCheckPersist : Yes - Accept Changes AddPortToActiveCookie : no RFCConform : yes CloseOnError : no AddViaHeaderInCacheResponses : no RSAreLocal : no DropOnRSFail : no DropAtDrainEnd : no L7AuthTimeoutSecs : 30 L7ClientTokenTimeoutSecs : 120 L7ConnectionDrainTimeoutSecs : 300 AdditionalL7Header : X-ClientSide OneHundredContinueHandling : RFC-2616 Compliant AllowEmptyPosts : no AllowEmptyHttpHeaders : no ForceCompleteRSMatch : no SlowStart : 0 ShareSubVSPersistance : no Get-AdcL7LogInsightSplitConfiguration Displays the log split interval value. Get AdcL7LogInsightSplitConfiguration Displays the log split interval value. Get-AdcL7LogInsightSplitConfiguration LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Get-AdcL7LogInsightSplitConfiguration LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Get-AdcL7LogInsightSplitConfiguration Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed; Data=} Return Code..: 200 Response.....: Command successfully executed Data field...: @{AdcL7Configuration=} Param........: @{ScalingOver64KConnections=no; AlwaysCheckPersist=Yes - Accept Changes; AddPortToActiveCookie=no; RFCConform=yes; CloseOnError=no; AddVi aHeaderInCacheResponses=no; RSAreLocal=no; DropOnRSFail=no; DropAtDrainEnd=no; L7AuthTimeoutSecs=30; L7ClientTokenTimeoutSecs=120; L7ConnectionDrainTime outSecs=300; AdditionalL7Header=X-ClientSide; OneHundredContinueHandling=RFC-2616 Compliant; AllowEmptyPosts=no; AllowEmptyHttpHeaders=no; ForceComplete RSMatch=no; SlowStart=0; ShareSubVSPersistance=no} ScalingOver64KConnections : no AlwaysCheckPersist : Yes - Accept Changes AddPortToActiveCookie : no RFCConform : yes CloseOnError : no AddViaHeaderInCacheResponses : no RSAreLocal : no DropOnRSFail : no DropAtDrainEnd : no L7AuthTimeoutSecs : 30 L7ClientTokenTimeoutSecs : 120 L7ConnectionDrainTimeoutSecs : 300 AdditionalL7Header : X-ClientSide OneHundredContinueHandling : RFC-2616 Compliant AllowEmptyPosts : no AllowEmptyHttpHeaders : no ForceCompleteRSMatch : no SlowStart : 0 ShareSubVSPersistance : no Get-AdcRealServer Returns a list of all Real Servers and their settings. Get AdcRealServer Returns a list of all Real Servers and their settings. Get-AdcRealServer VirtualService The address of the relevant Virtual Service. String VSPort The port of the relevant Virtual Service. Int32 VSProtocol The protocol of the relevant Virtual Service. String VSIndex The ID number of the relevant Virtual Service. Int32 RealServer The address of the relevant Real Server, if retrieving details about a particular Real Server. String RSPort The port number of the relevant Real Server, if retrieving details about a particular Real Server. Int32 RSIndex The ID number of the relevant Real Server, if retrieving details about a particular Real Server. Int32 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Get-AdcRealServer VirtualService The address of the relevant Virtual Service. String VSPort The port of the relevant Virtual Service. Int32 VSProtocol The protocol of the relevant Virtual Service. String VSIndex The ID number of the relevant Virtual Service. Int32 RealServer The address of the relevant Real Server, if retrieving details about a particular Real Server. String RSPort The port number of the relevant Real Server, if retrieving details about a particular Real Server. Int32 RSIndex The ID number of the relevant Real Server, if retrieving details about a particular Real Server. Int32 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String VirtualService The address of the relevant Virtual Service. String String VSPort The port of the relevant Virtual Service. Int32 Int32 VSProtocol The protocol of the relevant Virtual Service. String String VSIndex The ID number of the relevant Virtual Service. Int32 Int32 RealServer The address of the relevant Real Server, if retrieving details about a particular Real Server. String String RSPort The port number of the relevant Real Server, if retrieving details about a particular Real Server. Int32 Int32 RSIndex The ID number of the relevant Real Server, if retrieving details about a particular Real Server. Int32 Int32 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Get-AdcRealServer -VirtualService 10.154.11.181 -VSPort 443 -VSProtocol tcp Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Data field...: @{Rs=} Param........: @{Status=Down; VSIndex=1; RsIndex=4; Addr=10.154.11.84; Port=443; DnsName=; Forward=route; Weight=1000; Limit=0; Follow=0; Enable=Y; Crit ical=N} Get-AdcServiceHealth Allows you to see the values of the Service Check options. Get AdcServiceHealth Allows you to see the values of the Service Check options. Get-AdcServiceHealth LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Get-AdcServiceHealth LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Get-AdcServiceHealth Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Data field...: @{AdcServiceHealth=} CheckInterval : 9 ConnectionTimeout : 4 RetryCount : 2 Get-AdcSubVirtualService Retrieve details for a SubVS. Get AdcSubVirtualService This command returns details of the specified SubVS. Get-AdcSubVirtualService SubVSIndex The ID number of the SubVS to retrieve details for. Int32 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Get-AdcSubVirtualService SubVSIndex The ID number of the SubVS to retrieve details for. Int32 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String SubVSIndex The ID number of the SubVS to retrieve details for. Int32 Int32 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Get-AdcSubVirtualService Example: Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Data field...: @{VS=} Param........: @{Status=Down; Index=3; VSPort=0; Layer=7; Enable=Y; SSLReverse=N; SSLReencrypt=N; Intercept=N; InterceptOpts=; AlertThreshold=0; Transac tionlimit=0; Transparent=N; SubnetOriginating=Y; ServerInit=0; StartTLSMode=0; Idletime=660; Cache=N; Compress=N; Verify=0; UseforSnat=N; ForceL4=N; For ceL7=Y; MultiConnect=N; ClientCert=0; ErrorCode=0; CheckUse1.1=N; MatchLen=0; CheckUseGet=0; SSLRewrite=0; VStype=http; FollowVSID=0; Protocol=tcp; Sche dule=rr; CheckType=http; PersistTimeout=0; CheckPort=0; NRules=0; NRequestRules=0; NResponseRules=0; NPreProcessRules=0; EspEnabled=N; InputAuthMode=0; OutputAuthMode=0; MasterVS=0; MasterVSID=1; IsTransparent=2; AddVia=0; QoS=0; TlsType=0; NeedHostName=N; OCSPVerify=N; AllowHTTP2=N; EnhancedHealthCheck s=N; RsMinimum=0; NumberOfRSs=0} Get-AdcTotalVirtualService Retrieve details about the Virtual Services, SubVSs and Real Servers. Get AdcTotalVirtualService This command returns the total number of Virtual Services, SubVSs and Real Servers and also returns the total number of each that are up, down and disabled. Get-AdcTotalVirtualService LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Get-AdcTotalVirtualService LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Get-AdcTotalVirtualService Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. VSTotals : @{Total=6; Up=2; Down=4; Disabled=0} SUBVSTotals : @{Total=32; Up=0; Down=32; Disabled=0} RSTotals : @{Total=1; Up=0; Down=0; Disabled=1} Get-AdcVirtualService Get details for configured Virtual Services. Get AdcVirtualService Returns details of all Virtual Services on the LoadMaster. If details of a specific Virtual Service are entered in the parameters, only details relating to that Virtual Service will be displayed. Get-AdcVirtualService VirtualService The IP address of the Virtual Service to be displayed. String VSPort The port of the Virtual Service to retrieve the details for. Int32 VSProtocol The protocol of the Virtual Service to retrieve the details for. String VSIndex The index number of the Virtual Service to be displayed. Int32 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Get-AdcVirtualService VirtualService The IP address of the Virtual Service to be displayed. String VSPort The port of the Virtual Service to retrieve the details for. Int32 VSProtocol The protocol of the Virtual Service to retrieve the details for. String VSIndex The index number of the Virtual Service to be displayed. Int32 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String VirtualService The IP address of the Virtual Service to be displayed. String String VSPort The port of the Virtual Service to retrieve the details for. Int32 Int32 VSProtocol The protocol of the Virtual Service to retrieve the details for. String String VSIndex The index number of the Virtual Service to be displayed. Int32 Int32 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String Port The port of the Virtual Service to be displayed. int32 int32 Protocol The protocol of the Virtual Service to be displayed. string string -------------------------- Example -------------------------- PS C:\> Get-AdcVirtualService Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Data field...: @{Status=Down; Index=4; VSAddress=10.154.11.90; VSPort=80; Layer=7; Enable=Y; SSLReverse=N; SSLReencrypt=N; Intercept=N; InterceptOpts=; AlertThreshold=0; Transactionlimit=0; Transparent=N; SubnetOriginating=Y; ServerInit=0; StartTLSMode=0; Idletime=660; Cache=N; Compress=N; Verify=0; Use forSnat=N; ForceL4=N; ForceL7=Y; MultiConnect=N; ClientCert=0; ErrorCode=0; CheckUse1.1=N; MatchLen=0; CheckUseGet=0; SSLRewrite=0; VStype=http; FollowV SID=0; Protocol=tcp; Schedule=rr; CheckType=http; PersistTimeout=0; CheckPort=0; NRules=0; NRequestRules=0; NResponseRules=0; NPreProcessRules=0; EspEna bled=N; InputAuthMode=0; OutputAuthMode=0; MasterVS=0; MasterVSID=0; IsTransparent=2; AddVia=0; QoS=0; TlsType=0; NeedHostName=N; OCSPVerify=N; AllowHTT P2=N; EnhancedHealthChecks=N; RsMinimum=0; NumberOfRSs=0} Param........: @{Status=Down; Index=4; VSAddress=10.154.11.90; VSPort=80; Layer=7; Enable=Y; SSLReverse=N; SSLReencrypt=N; Intercept=N; InterceptOpts=; AlertThreshold=0; Transactionlimit=0; Transparent=N; SubnetOriginating=Y; ServerInit=0; StartTLSMode=0; Idletime=660; Cache=N; Compress=N; Verify=0; Use forSnat=N; ForceL4=N; ForceL7=Y; MultiConnect=N; ClientCert=0; ErrorCode=0; CheckUse1.1=N; MatchLen=0; CheckUseGet=0; SSLRewrite=0; VStype=http; FollowV SID=0; Protocol=tcp; Schedule=rr; CheckType=http; PersistTimeout=0; CheckPort=0; NRules=0; NRequestRules=0; NResponseRules=0; NPreProcessRules=0; EspEna bled=N; InputAuthMode=0; OutputAuthMode=0; MasterVS=0; MasterVSID=0; IsTransparent=2; AddVia=0; QoS=0; TlsType=0; NeedHostName=N; OCSPVerify=N; AllowHTT P2=N; EnhancedHealthChecks=N; RsMinimum=0; NumberOfRSs=0} Status : Down Index : 4 VSAddress : 10.154.11.90 VSPort : 80 Layer : 7 Enable : Y SSLReverse : N SSLReencrypt : N Intercept : N InterceptOpts : @{Opt=System.Object[]} AlertThreshold : 0 Transactionlimit : 0 Transparent : N SubnetOriginating : Y ServerInit : 0 StartTLSMode : 0 Idletime : 660 Cache : N Compress : N Verify : 0 UseforSnat : N ForceL4 : N ForceL7 : Y MultiConnect : N ClientCert : 0 ErrorCode : 0 CheckUse1.1 : N MatchLen : 0 CheckUseGet : 0 SSLRewrite : 0 VStype : http FollowVSID : 0 Protocol : tcp Schedule : rr CheckType : http PersistTimeout : 0 CheckPort : 0 NRules : 0 NRequestRules : 0 NResponseRules : 0 NPreProcessRules : 0 EspEnabled : N InputAuthMode : 0 OutputAuthMode : 0 MasterVS : 0 MasterVSID : 0 IsTransparent : 2 AddVia : 0 QoS : 0 TlsType : 0 NeedHostName : N OCSPVerify : N AllowHTTP2 : N EnhancedHealthChecks : N RsMinimum : 0 NumberOfRSs : 0 Get-AdcVsWafRule Retrieve the status of a Web Application Firewall (WAF) rule. Get AdcVsWafRule This command shows if the specified WAF rule is active/inactive. Get-AdcVsWafRule VS The address of the relevant Virtual Service. String VSPort The port of the relevant Virtual Service. String VSProtocol The port of the relevant Virtual Service. String Rule The <RuleName> must be preceded with the relevant letter or word and a forward slash. The letter/word used depends on the type of rule being checked: C or Custom Z or ApplicationGeneric A or ApplicationSpecific G or Generic This is case sensitive. The letter/word needs to be in in the correct case for the command to work. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Get-AdcVsWafRule VS The address of the relevant Virtual Service. String VSPort The port of the relevant Virtual Service. String VSProtocol The port of the relevant Virtual Service. String Rule The <RuleName> must be preceded with the relevant letter or word and a forward slash. The letter/word used depends on the type of rule being checked: C or Custom Z or ApplicationGeneric A or ApplicationSpecific G or Generic This is case sensitive. The letter/word needs to be in in the correct case for the command to work. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String VS The address of the relevant Virtual Service. String String VSPort The port of the relevant Virtual Service. String String VSProtocol The port of the relevant Virtual Service. String String Rule The <RuleName> must be preceded with the relevant letter or word and a forward slash. The letter/word used depends on the type of rule being checked: C or Custom Z or ApplicationGeneric A or ApplicationSpecific G or Generic This is case sensitive. The letter/word needs to be in in the correct case for the command to work. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Get-AdcVsWafRule -Rule G/ip_reputation -VS 10.35.47.16 -VSPort 80 -VSProtocol tcp Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. ip_reputation : Inactive Get-AFEConfiguration WARNING: This function is deprecated. Use the following command instead: Get-LmAFEConfiguration Get AFEConfiguration WARNING: This function is deprecated. Use the following command instead: Get-LmAFEConfiguration Get-AFEConfiguration LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String Get-AFEConfiguration LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String Get-AllParameters WARNING: This function is deprecated. Use the following command instead: Get-LmAllParameters Get AllParameters WARNING: This function is deprecated. Use the following command instead: Get-LmAllParameters Get-AllParameters LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Get-AllParameters LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Get-AllParameters Example Output: dfltgw : 172.20.0.1 snat : no hamode : 0 sshaccess : yes sshport : 22 wuiaccess : yes wuiiface : 0 wuiport : 443 sshiface : all hoverhelp : yes routefilter : no transparent : no expect100 : 0 localbind : no addcookieport : no subnetoriginating : yes nonlocalrs : no multigw : no addforwardheader : 0 conntimeout : 660 authtimeout : 30 finalpersist : 300 tcptimestamp : no paranoia : 1 cachesize : 100 hostcache : no resetclose : no rfcconform : yes keepalive : yes backupday : 0 backupenable : no backuphour : 0 backupminute : 0 backuppassword : ******** enableapi : yes emailpassword : ******** emailsslmode : 0 emailport : 0 addvia : no allowupload : no dropatdrainend : no droponfail : no closeonerror : no limitinput : 0 rsarelocal : no slowstart : 0 subnetorigin : yes syslogcritical : 10.35.0.190 syslogemergency : 10.35.0.190 syslogerror : 10.35.0.190 sysloginfo : 10.35.0.190 syslognotice : 10.35.0.190 syslogwarn : 10.35.0.190 sslrenegotiate : no dnssecclient : yes emailenable : no irqbalance : no snmpenable : no snmpV3enable : no snmpv3userpasswd : ******** snmpHaTrap : no snmptrapenable : no motd : <h1>This device is being managed by KEMP360</h1> wuidisplaylines : 0 linearesplogs : no onlydefaultroutes : no sessionauthmode : 0 sessionidletime : 0 sessionmaxfailattempts : 0 sessioncontrol : no sessionbasicauth : yes sessionconcurrent : 0 adminclientaccess : 0 sessionlocalauth : no ntpkeyid : 0 ntpkeysecret : ******** netconsoleinterface : 0 namserver : 10.154.11.192 radiusbackupport : 0 radiusbackupsecret : ******** radiusport : 0 radiussecret : ******** radiusrevalidateinterval : 60 ldapsecurity : 0 ldaprevalidateinterval : 60 geosshport : 22 hostname : lb100 admincert : No Admin Certificate assigned localcert : Only available in HA mode time : Tue, 15 Mar 16 15:08:38 UTC serialnumber : 1051082 version : 7.1.35.0.12508.DEV Tethering : yes multihomedwui : no logsplitinterval : 10 allowemptyposts : no OCSPPort : 0 OCSPUseSSL : no OCSPOnServerFail : no L7LimitInput : 0 sdnstatsmode : 0 dhkeysize : 2048 WUITLSProtocols : 0 WUICipherset : Intermediate_compatibility Get-AslLicenseType Retrieve a list of available license types. Get AslLicenseType Retrieve a list of available license types when using Activation Server functionality. Get-AslLicenseType aslipaddr Specify the Activation Server IP address (the IP address of the KEMP 360 Central machine being used to activate the license). String aslport Specify the Activation Server port (the port of the KEMP 360 Central machine being used to activate the license). Int32 aslname Specify the Activation Server name (the name of the KEMP 360 Central machine being used to activate the license). String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential Object InformationAction ActionPreference InformationVariable String Get-AslLicenseType aslipaddr Specify the Activation Server IP address (the IP address of the KEMP 360 Central machine being used to activate the license). String aslport Specify the Activation Server port (the port of the KEMP 360 Central machine being used to activate the license). Int32 aslname Specify the Activation Server name (the name of the KEMP 360 Central machine being used to activate the license). String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String aslipaddr Specify the Activation Server IP address (the IP address of the KEMP 360 Central machine being used to activate the license). String String aslport Specify the Activation Server port (the port of the KEMP 360 Central machine being used to activate the license). Int32 Int32 aslname Specify the Activation Server name (the name of the KEMP 360 Central machine being used to activate the license). String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String -------------------------- Example -------------------------- PS C:\> Get-AslLicenseType -LoadBalancer 10.35.41.63 -Verbose -aslipaddr 10.35.41.53 -aslport 443 Example Output: Full response: Command successfully executed. Return Code..: 200 Response.....: Command successfully executed Data field...: @{OrderID=; AvailableLicenses=1; Licenses=} Param........: id : 0be64d5fb077d757c691e6745cf68c6c035e9635 name : VLM-5000 ESP GEO with Evaluation + WAF description : VLM-5000 ESP GEO with Evaluation + WAF available : 1 tethered : False Get-AwsHAOption WARNING: This function is deprecated. Use the following command instead: Get-LmAwsHAConfiguration Get AwsHAOption WARNING: This function is deprecated. Use the following command instead: Get-LmAwsHAConfiguration Get-AwsHAOption LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Get-AwsHAOption LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String -------------------------- Example -------------------------- PS C:\> Get-AwsHAOption Example Output: AwsHA master,192.168.1.1,8443 Get-AzureHAOption WARNING: This function is deprecated. Use the following command instead: Get-LmAzureHAConfiguration Get AzureHAOption WARNING: This function is deprecated. Use the following command instead: Get-LmAzureHAConfiguration Get-AzureHAOption LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Get-AzureHAOption LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String -------------------------- Example -------------------------- PS C:\> Get-AzureHAOption Example Output: (This is a legacy command and has been replaced with the Get-ClusterAzureHAConfiguration command.) Get-BackupOption WARNING: This function is deprecated. Use the following command instead: Get-LmBackupConfiguration Get BackupOption WARNING: This function is deprecated. Use the following command instead: Get-LmBackupConfiguration Get-BackupOption LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String Get-BackupOption LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String GetCipherset WARNING: This function is deprecated. Use the following command instead: Get-TlsCipherSet WARNING: This function is deprecated. Use the following command instead: Get-TlsCipherSet GetCipherset Name String LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String GetCipherset Name String LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String Name String String LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String Get-ClusterStatus Retrieves the status of the cluster. Get ClusterStatus Retrieves the status of the cluster. Get-ClusterStatus LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Get-ClusterStatus LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Get-ClusterStatus Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. {SharedAddress=172.16.178.178; Node=System.Object[]} $get.Data.ClusterConfiguration SharedAddress Node ------------- ---- 172.16.178.178 {@ {Id=1; Address=172.16.176.1; Enabled=1; Status=5} , @ {Id=2; Address=172.16.178.1; Enabled=0; Status=2} , @{Id=3; Add... $get.Data.ClusterConfiguration.Node Id Address Enabled Status – ------- ------- ------ 1 172.16.176.1 1 5 2 172.16.178.1 0 2 3 172.16.191.1 0 2 $get.Data.ClusterConfiguration.SharedAddress 172.16.178.178 Get-DateTimeOption WARNING: This function is deprecated. Use the following command instead: Get-LmDateTimeConfiguration Get DateTimeOption WARNING: This function is deprecated. Use the following command instead: Get-LmDateTimeConfiguration Get-DateTimeOption LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String Get-DateTimeOption LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String Get-DebugOption WARNING: This function is deprecated. Use the following command instead: Get-LmDebugConfiguration Get DebugOption WARNING: This function is deprecated. Use the following command instead: Get-LmDebugConfiguration Get-DebugOption LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String Get-DebugOption LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String Get-DNSConfiguration WARNING: This function is deprecated. Use the following command instead: Get-NetworkDNSConfiguration Get DNSConfiguration WARNING: This function is deprecated. Use the following command instead: Get-NetworkDNSConfiguration Get-DNSConfiguration LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String Get-DNSConfiguration LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String Get-EmailOption WARNING: This function is deprecated. Use the following command instead: Get-LogEmailConfiguration Get EmailOption WARNING: This function is deprecated. Use the following command instead: Get-LogEmailConfiguration Get-EmailOption LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String Get-EmailOption LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String Get-GeoCluster Display all GEO clusters, or one specific GEO cluster. Get GeoCluster Run this command without the IP parameter to display all all clusters. Specify an IP address in order to display details for one specific cluster. Get-GeoCluster ClusterIp The IP address of the cluster to retrieve. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Get-GeoCluster ClusterIp The IP address of the cluster to retrieve. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String ClusterIp The IP address of the cluster to retrieve. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String IP To display details for one particular GEO cluster, specify the IP address of the cluster using this parameter. string string -------------------------- Example -------------------------- PS C:\> Get-GeoCluster -ClusterIp 10.34.52.55 Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Index : 1 Status : Up Name : ExampleCluster ClusterVSAddress : IPAddress : 10.34.52.55 Checker : none CheckerPort : 80 Type : default Enable : Y LocationLatitude : LocationLongitude : Get-GeoCustomLocation Retrieves a list of any existing custom locations. Get GeoCustomLocation Retrieves a list of any existing custom locations. Get-GeoCustomLocation LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Get-GeoCustomLocation LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Get-GeoCustomLocation Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Name : Limerick Get-GeoDNSSECConfiguration Retrieve the DNSSEC settings. Get GeoDNSSECConfiguration Retrieve the DNSSEC settings. Get-GeoDNSSECConfiguration LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Get-GeoDNSSECConfiguration LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Get-GeoDNSSECConfiguration Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. PublicKey --------- ExampleZone. IN DNSKEY 257 3 8 AwEAAeRfz2/QoPCphUgG2nK/DK8u8xxbseh64lDRydZHbGRTM8XjXd6v +lt9peqGFqulejJe0ojI0KrBVZqwkPkEuwujqL+zaYG6/SfW0xRdzEdP SF... Get-GeoFQDN Display settings for either all FQDNs, or a specific FQDN. Get GeoFQDN Set the FQDN parameter to display details for a specific FQDN. To display details for all FQDNs, do not use the FQDN parameter. Get-GeoFQDN FQDN To display details for a specific FQDN - specify the name of the FQDN using this parameter. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Get-GeoFQDN FQDN To display details for a specific FQDN - specify the name of the FQDN using this parameter. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String FQDN To display details for a specific FQDN - specify the name of the FQDN using this parameter. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Get-GeoFQDN -FQDN Example.com Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. SelectionCriteria : RoundRobin SiteRecoveryMode : auto Mapping : 0 LocalSettings : 0 UnanimousChecks : N Failover : N SiteFailureDelay : 0 Fqdn : Example.com. PrivateRequest : 0 PublicRequest : 0 Get-GeoIPBlacklistDatabaseConfiguration Retrieve the GEO IP blacklist settings. Get GeoIPBlacklistDatabaseConfiguration Run this command to retrieve the GEO IP blacklist settings, such as the: - Date of the last update - Date of the last install - Auto-update setting - Auto-install settings Get-GeoIPBlacklistDatabaseConfiguration LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Get-GeoIPBlacklistDatabaseConfiguration LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Get-GeoIPBlacklistDatabaseConfiguration Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. AutoUpdate : yes LastUpdated : 03 May 2017 14:55:09 AutoInstall : no InstallTimeHour : 4 LastInstalled : 03 May 2017 14:55:19 Get-GeoIpRange Displays details of all IP ranges, or one specific IP range. Get GeoIpRange To retrieve details for a specific IP range, set the IP parameter. To retrieve details for all IP ranges, do not use the IP parameter. Get-GeoIpRange IP Specify the IP address of the range to display details for. Do not use this parameter if you want to retrieve details for all IP ranges. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Get-GeoIpRange IP Specify the IP address of the range to display details for. Do not use this parameter if you want to retrieve details for all IP ranges. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String IP Specify the IP address of the range to display details for. Do not use this parameter if you want to retrieve details for all IP ranges. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Get-GeoIpRange Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Index : 1 Ip : 10.154.11.55 IPAddress : 10.154.11.55 Mask : 32 Country : IsCustom : N Get-GeoIPWhitelist Retrieve the contents of the user-defined GEO IP whitelist. Get GeoIPWhitelist The whitelist overrides the blacklist. Get-GeoIPWhitelist LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Get-GeoIPWhitelist LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Get-GeoMiscParameter Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Data field...: @{GeoWhiteList=} Param........: @{addr=System.Object[]} addr ---- {20.54.56.26/32, 12.45.54.33/32} Get-GeoMiscParameter Displays the values of the miscellaneous GEO parameters. Get GeoMiscParameter Shows settings relating to Source of Authority, Resource Check Parameters and Stickiness. Get-GeoMiscParameter LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Get-GeoMiscParameter LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Get-GeoMiscParameter Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. soa : @{TTL=10; persist=60; Zone=; SourceOfAuthority=; NameSrv=; SOAEmail=} check : @{CheckInterval=120; ConnTimeout=20; RetryAttempts=2} Get-GeoPartnerStatus Returns the status of all configured GEO partners. Get GeoPartnerStatus The status returned is either: - Up - Down - Empty: An empty list is returned if there are no GEO partners configured. - Unknown: If a status for a particular partner is not known Get-GeoPartnerStatus LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Get-GeoPartnerStatus LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Get-GeoPartnerStatus Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Address : 10.154.11.180 Status : Down Get-GlobalPacketFilterACL Displays the addresses on the global black or white list. Get GlobalPacketFilterACL Lists the host and network IP addresses on the global black or white access control list. Note that black and white lists are only enabled when packet filtering is enabled. Get-GlobalPacketFilterACL Type Specifies the access control list type: "black" or "white". String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Get-GlobalPacketFilterACL Type Specifies the access control list type: "black" or "white". String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String Type Specifies the access control list type: "black" or "white". String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Get-GlobalPacketFilterACL -Type black Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Data field...: @{Blacklist=} Param........: @{addr=10.154.11.12/32; comment=Example comment} Get-HAOption WARNING: This function is deprecated. Use the following command instead: Get-LmHAConfiguration Get HAOption WARNING: This function is deprecated. Use the following command instead: Get-LmHAConfiguration Get-HAOption LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String Get-HAOption LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String Get-HostsEntry Lists the existing hosts for local resolution. Get HostsEntry This command returns a list of host IP addresses and host FQDNs for local resolution. Get-HostsEntry LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Get-HostsEntry LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Get-HostsEntry Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Data field...: @{LocalHosts=} Param........: @{HostIPAddress=10.154.33.233; HostFqdn=example.com} HostIPAddress : 10.154.33.233 HostFqdn : example.com Get-Interface WARNING: This function is deprecated. Use the following command instead: Get-NetworkInterface Get Interface WARNING: This function is deprecated. Use the following command instead: Get-NetworkInterface Get-Interface InterfaceID Int16 LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String Get-Interface InterfaceID Int16 LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String InterfaceID Int16 Int16 LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String Get-L7Configuration WARNING: This function is deprecated. Use the following command instead: Get-AdcL7Configuration Get L7Configuration WARNING: This function is deprecated. Use the following command instead: Get-AdcL7Configuration Get-L7Configuration LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String Get-L7Configuration LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String Get-LdapEndpoint Retrieve details for existing LDAP endpoints. Get LdapEndpoint If you do not specify a value in the name parameter the output will display details of all existing endpoints. Specify a name to retreive details for that specific LDAP endpoint. Get-LdapEndpoint Name The name of the LDAP endpoint to retreive details for. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Get-LdapEndpoint Name The name of the LDAP endpoint to retreive details for. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String Name The name of the LDAP endpoint to retreive details for. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Get-LdapEndpoint Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Data field...: @{LDAPEndPoint=System.Object[]} Param........: name : EXAMPLE vinterval : 60 server : 10.154.11.103 10.154.11.104 adminuser : ExampleUser adminpass : ******** LdapProtocol : Unencrypted ReferralCount : 6 name : EXAMPLE2 vinterval : 60 server : 10.154.11.32 adminuser : exampleuser adminpass : ******** LdapProtocol : StartTLS ReferralCount : 0 Get-LicenseAccessKey Allows you to get the access key of the LoadMaster. Get LicenseAccessKey Allows you to get the access key of the LoadMaster. Get-LicenseAccessKey LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Get-LicenseAccessKey LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Get-LicenseAccessKey Example Output: Full response: Command successfully executed. Return Code..: 200 Response.....: Command successfully executed Data field...: @{AccessKey=mmw14-97w51-cr45g-88x5g} Get-LicenseInfo Retrieves the license details for the LoadMaster. Get LicenseInfo Retrieves the license details for the LoadMaster. Get-LicenseInfo LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Get-LicenseInfo LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> $get = Get-LicenseInfo -Credential bal -LoadBalancer 10.154.11.180 Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Data field...: @{LicenseInfo=} Param........: @{uuid=31159ab6-5da4-4b92-8ee2-b8922cc08dfe; ActivationDate=Tue Nov 15 10:32:34 UTC 2016; LicensedUntil=unlimited; SupportLevel=; Support Until=none; LicenseType=; LicenseStatus=Single Perm; ApplianceModel=; MaxVS=0; MaxRS=0; Bandwidth=5000; TpsLimit=10000; HA=no; FirstHA=no; ModSecurity=n o; AFE=yes; ViewAFE=yes; ESP=yes; IPSEC=0; SingleCPU=no; VLM=no; FreeLicense=no; Temporary=no; ASL=no; MandatoryTether=no; MultipleConnect=no} uuid : 31159ab6-5da4-4b92-8ee2-b8922cc08dfe ActivationDate : Tue Nov 15 10:32:34 UTC 2016 LicensedUntil : unlimited SupportLevel : SupportUntil : none LicenseType : LicenseStatus : Single Perm ApplianceModel : MaxVS : 0 MaxRS : 0 Bandwidth : 5000 TpsLimit : 10000 HA : no FirstHA : no ModSecurity : no AFE : yes ViewAFE : yes ESP : yes IPSEC : 0 SingleCPU : no VLM : no FreeLicense : no Temporary : no ASL : no MandatoryTether : no MultipleConnect : no Get-LicenseType Retrieve a list of available license types for a particular KEMP ID. Get LicenseType If successful, the output provides a list of license types and associated IDs. The ID number is used when licensing using the Request-LicenseOnline command. Get-LicenseType KempId The KEMP ID (email address) to retrieve the license types for. String Password The password for the KEMP ID being used. String OrderId The Orderid parameter is only needed for Virtual LoadMasters. The Order ID is provided by KEMP after a license is purchased. String http_proxy Specify the HTTP(S) proxy server and port, in the format <ProxyAddress>:<Port>. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username used to connect to the LoadMaster. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. Object InformationAction ActionPreference InformationVariable String Get-LicenseType KempId The KEMP ID (email address) to retrieve the license types for. String Password The password for the KEMP ID being used. String OrderId The Orderid parameter is only needed for Virtual LoadMasters. The Order ID is provided by KEMP after a license is purchased. String http_proxy Specify the HTTP(S) proxy server and port, in the format <ProxyAddress>:<Port>. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String KempId The KEMP ID (email address) to retrieve the license types for. String String Password The password for the KEMP ID being used. String String OrderId The Orderid parameter is only needed for Virtual LoadMasters. The Order ID is provided by KEMP after a license is purchased. String String http_proxy Specify the HTTP(S) proxy server and port, in the format <ProxyAddress>:<Port>. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username used to connect to the LoadMaster. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Get-LicenseType -KempId jbloggs@kemptechnologies.com -Password ExamplePassword -LoadBalancer 172.16.129.72 -Credential bal Example Output: Full response: Command successfully executed. Return Code..: 200 Response.....: Command successfully executed Data field...: @{name=VLM-5000 with Enterprise Plus subscription; available=1; tethered=0; id=69cc7829c122f7a1604d97c5224c56f596b4f718; LicenseSt... Param........: name : VLM-5000 with Enterprise Plus subscription available : 1 tethered : 0 id : 69cc7829c122f7a1604d97c5224c56f596b4f718 LicenseStatus : Temp License description : VLM-5000 with Enterprise Plus subscription BuyMoreAt : https://www.kemptechnologies.com/buy-me-now?KEMPID=jbloggs@kemptechnologies.com -------------------------- Example (with Order ID) -------------------------- PS C:\> Get-LicenseType -KempId jbloggs@kemptechnologies.com -Password ExamplePassword -LoadBalancer 172.16.129.72 -Credential bal -OrderId ExampleOrderID Example Output: Full response: Command successfully executed. Return Code..: 200 Response.....: Command successfully executed Data field...: @{id=2010d06f77b2d646677b1fd0b4688c019b66ddb7; name=VLM-200 with Enterprise Plus subscription; available=1; description=VLM-200 wi... Param........: id : 2010d06f77b2d646677b1fd0b4688c019b66ddb7 name : VLM-200 with Enterprise Plus subscription available : 1 description : VLM-200 with Enterprise Plus subscription tethered : False LicenseStatus : Permanent License BuyMoreAt : https://www.kemptechnologies.com/buy-me-now?KEMPID=jbloggs@kemptechnologies.com id : b2eb3e9260958b57743fd1a2cf704915754085b7 name : VLM-2000 with Enterprise Plus subscription available : 1 description : VLM-2000 with Enterprise Plus subscription tethered : False LicenseStatus : Permanent License BuyMoreAt : https://www.kemptechnologies.com/buy-me-now?KEMPID=jbloggs@kemptechnologies.com id : be9fbc4ca4f0f5e023809aa4fc7b399ed7bd0d76 name : VLM-GEO with Enterprise Plus subscription available : 1 description : VLM-GEO with Enterprise Plus subscription tethered : False LicenseStatus : Permanent License BuyMoreAt : https://www.kemptechnologies.com/buy-me-now?KEMPID=jbloggs@kemptechnologies.com name : VLM-5000 with Enterprise Plus subscription available : 1 tethered : 0 id : 69cc7829c122f7a1604d97c5224c56f596b4f718 LicenseStatus : Temp License description : VLM-5000 with Enterprise Plus subscription BuyMoreAt : https://www.kemptechnologies.com/buy-me-now?KEMPID=jbloggs@kemptechnologies.com Get-LmAddOn Displays a list of any add-on packages that are installed on the LoadMaster. Get LmAddOn Displays a list of any add-on packages that are installed on the LoadMaster. Get-LmAddOn LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Get-LmAddOn LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Get-LmAddOn Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Data field...: @{Package=} Param........: Name Installed Version Started ---- --------- ------- ------- Vmtoolsd Thu Sep 15 05:58:56 2016 7.2.37.0.13719.DEV yes Get-LmAFEConfiguration Allows you to view the values of Cache, Compression and IPS options. Get LmAFEConfiguration Allows you to view the values of Cache, Compression and IPS options. Get-LmAFEConfiguration LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.ster that you are directing the command to. This can be set globally by using the Initialize-LoadBalancer command, but can be overridden on each individual command by using this parameter. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Get-LmAFEConfiguration LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.ster that you are directing the command to. This can be set globally by using the Initialize-LoadBalancer command, but can be overridden on each individual command by using this parameter. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it.ster that you are directing the command to. This can be set globally by using the Initialize-LoadBalancer command, but can be overridden on each individual command by using this parameter. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Get-LmAFEConfiguration Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Cachesize HostCache LimitInput DetectionLevel --------- --------- ---------- -------------- 100 no 0 Default Get-LmAllParameters Retrieve a list of all parameters that can be retrieved using the Get-LmParameter command. Get LmAllParameters Retrieve a list of all parameters that can be retrieved using the Get-LmParameter command and set using the Set-LmParameter command. Get-LmAllParameters LoadBalancer The IP address of the KEMP LoadMaster that you are directing the command to. This can be set globally by using the Initialize-LoadBalancer command, but can be overridden on each individual command by using this parameter. String LBPort The port of the load balancer. Int32 Credential Specifies a user account that has permission to administer the load balancer. You can either enter a username for the load balancer or provide a PSCredential object, such as an object that is returned by the Get-Credential cmdlet. When you type a username, you are prompted for a password. Object InformationAction ActionPreference InformationVariable String Get-LmAllParameters LoadBalancer The IP address of the KEMP LoadMaster that you are directing the command to. This can be set globally by using the Initialize-LoadBalancer command, but can be overridden on each individual command by using this parameter. String LBPort The port of the load balancer. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. String InformationAction ActionPreference InformationVariable String LoadBalancer The IP address of the KEMP LoadMaster that you are directing the command to. This can be set globally by using the Initialize-LoadBalancer command, but can be overridden on each individual command by using this parameter. String String LBPort The port of the load balancer. Int32 Int32 Credential Specifies a user account that has permission to administer the load balancer. You can either enter a username for the load balancer or provide a PSCredential object, such as an object that is returned by the Get-Credential cmdlet. When you type a username, you are prompted for a password. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. String String -------------------------- Example -------------------------- PS C:\> $get = Get-LmAllParameters $get Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Data field...: @{AllParameters=} Param........: dfltgw : 10.154.0.1 snat : yes hatimeout : 1 hawait : 0 haprefered : 0 hamode : 1 hastatus : standby haif : 0 havhid : 0 hainitial : no tcpfailover : no cookieupdate : no hal4update : no hal7update : no vmac : no sshaccess : yes sshport : 22 wuiaccess : yes mcast : 0 wuiiface : 0 wuiport : 443 sshiface : all hoverhelp : yes routefilter : no transparent : no alwayspersist : 2 expect100 : 0 localbind : no addcookieport : no subnetoriginating : yes nonlocalrs : no multigw : no addforwardheader : 0 conntimeout : 660 authtimeout : 30 clienttokentimeout : 120 finalpersist : 300 tcptimestamp : no paranoia : 1 cachesize : 100 hostcache : no resetclose : no rfcconform : yes keepalive : yes backupday : 0 backupenable : yes backuphour : 0 backupminute : 0 backuppassword : ******** backupnetstat : yes backupsecure : yes backupident : ******** enableapi : yes emailuser : test emaildomain : ExampleDomain emailpassword : ******** emailserver : 10.154.22.132 emailsslmode : 1 emailport : 80 addvia : no allowupload : no dropatdrainend : no droponfail : no closeonerror : no limitinput : 0 rsarelocal : no slowstart : 0 subnetorigin : yes sysloginfo : 10.154.153.94 sslrenegotiate : no dnssecclient : yes emailenable : yes irqbalance : no snmpenable : yes snmpV3enable : no snmpv3userpasswd : ******** snmpHaTrap : no snmptrapenable : no motd : &lt;h1&gt;This device is being managed by KEMP360&lt;/h1&gt; wuidisplaylines : 0 linearesplogs : no onlydefaultroutes : no sessionauthmode : 19 sessionidletime : 0 sessionmaxfailattempts : 0 sessioncontrol : yes sessionbasicauth : no sessionconcurrent : 0 adminclientaccess : 1 sessionlocalauth : no ntpkeyid : 0 ntpkeysecret : ******** netconsoleinterface : 0 nameserver : 10.154.75.25 namserver : 10.154.75.25 wuildapep : EXAMPLE geopartners : 10.154.11.190 geosshport : 22 geosshiface : 0 hostname : lb100 searchlist : KEMP.LAB.INTRA admincert : No Admin Certificate assigned localcert : No Local Admin Certificate assigned time : Thu, 20 Apr 17 10:14:21 UTC boottime : Tue, 11 Apr 17 13:36:17 UTC activetime : Thu, 01 Jan 70 00:00:00 UTC serialnumber : 446312 version : 7.2.39.0.14938.DEV Tethering : yes multihomedwui : no logsplitinterval : 10 allowemptyposts : no OCSPPort : 0 OCSPUseSSL : no OCSPOnServerFail : no L7LimitInput : 0 sdnstatsmode : 0 dhkeysize : 2048 WUITLSProtocols : 0 AllowEmptyHttpHeaders : no ShareSubVSPersist : no DNSNamesEnable : yes ForceFullRSMatch : no SSLForceServerVerify : no SyslogPort : 60 SSLStapling : no SSLRefreshInterval : 3700 Get-LmAwsHAConfiguration Retrieve the AWS High Availability (HA) parameters. Get LmAwsHAConfiguration Display the HA settings for a LoadMaster on Azure. Get-LmAwsHAConfiguration LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Get-LmAwsHAConfiguration LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Get-LmAwsHAConfiguration Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed; Data=} Return Code..: 200 Response.....: Command successfully executed Data field...: @{AwsHAConfiguration=} HaMode Partner HealthCheckPort ------ ------- --------------- single unset unset Get-LmAzureHAConfiguration Retrieves the Azure High Availability (HA) parameters. Get LmAzureHAConfiguration Displays the HA settings for an Azure LoadMaster. Get-LmAzureHAConfiguration LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Get-LmAzureHAConfiguration LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Get-LmAzureHAConfiguration Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed; Data=} Return Code..: 200 Response.....: Command successfully executed Data field...: @{AzureHAConfiguration=} HaMode Partner HealthCheckPort ------ ------- --------------- single unset unset Get-LmBackupConfiguration Allows to view the values of the Automated Backup options. Get LmBackupConfiguration Allows to view the values of the Automated Backup options. Get-LmBackupConfiguration LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Get-LmBackupConfiguration LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Get-LmBackupConfiguration Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed; Data=} Return Code..: 200 Response.....: Command successfully executed Data field...: @{BackupConfiguration=} Param........: @{backupenable=yes; backuphour=0; backupminute=0; backupday=0; BackupMethod=SCP; backupuser=; backuppassword=********; backuphost=; back uppath=} backupenable : yes backuphour : 0 backupminute : 0 backupday : 0 BackupMethod : SCP backupuser : backuppassword : ******** backuphost : backuppath : Get-LmDateTimeConfiguration Allows you to view the values of the Date and Time options. Get LmDateTimeConfiguration Allows you to view the values of the Date and Time options. Get-LmDateTimeConfiguration LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Get-LmDateTimeConfiguration LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String This is a legacy command and does not return all of the available parameters. Please refer to the Get-Help of the Get-Parameter command to view a full list of parameters that can be returned. -------------------------- Example -------------------------- PS C:\> Get-LmDateTimeConfiguration Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed; Data=} Return Code..: 200 Response.....: Command successfully executed Data field...: @{DateTimeConfiguration=} Param........: @{NTPHost=; Time=Thu, 20 Apr 17 11:12:59 UTC; BootTime=Thu, 20 Apr 17 11:02:28 UTC; ActiveTime=Thu, 20 Apr 17 11:02:28 UTC; TimeZone=; NT PKeyId=0} Get-LmDebugConfiguration Displays the Debug Option values. Get LmDebugConfiguration Allows you to view some of the values of options contained in the in the Debug Option screen of the WUI. Get-LmDebugConfiguration LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Get-LmDebugConfiguration LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Get-LmDebugConfiguration Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. irqbalance : no linearesplogs : no netconsole : netconsoleinterface : 0 Get-LmDebugInformation Returns the system information related to the specified command option. Get LmDebugInformation Returns the system information related to the specified command option. Get-LmDebugInformation Param Valid values and their descriptions are provided below: - ps: Report a snapshot of the current processes. - meminfo: Report the memory status of the LoadMaster. - ifconfig: Return the details of the network interfaces. - netstat: Return the following information: - Active Internet connections, servers and established (IPv4/IPv6) - Kernel IP routing table (IPv4/IPv6) - IPv4/IPv6 packet filter - interrupts: Lists the number of interrupts per CPU per I/O device. - partitions: Partition block allocation information. - cpuinfo: Return the details of the LoadMaster CPU(s). - df: Display the device name, total blocks, total disk space, used disk space, available disk space and mount points on the LoadMaster file system. - lspci: Returns information about PCI buses in the system and devices connected to them. - lsmod: Show the status of modules in the Linux Kernel - slabinfo: Return statistics for frequently used objects in the Linux kernel (buffer heads, inodes, dentries and so on). String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Get-LmDebugInformation Param Valid values and their descriptions are provided below: - ps: Report a snapshot of the current processes. - meminfo: Report the memory status of the LoadMaster. - ifconfig: Return the details of the network interfaces. - netstat: Return the following information: - Active Internet connections, servers and established (IPv4/IPv6) - Kernel IP routing table (IPv4/IPv6) - IPv4/IPv6 packet filter - interrupts: Lists the number of interrupts per CPU per I/O device. - partitions: Partition block allocation information. - cpuinfo: Return the details of the LoadMaster CPU(s). - df: Display the device name, total blocks, total disk space, used disk space, available disk space and mount points on the LoadMaster file system. - lspci: Returns information about PCI buses in the system and devices connected to them. - lsmod: Show the status of modules in the Linux Kernel - slabinfo: Return statistics for frequently used objects in the Linux kernel (buffer heads, inodes, dentries and so on). String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String Param Valid values and their descriptions are provided below: - ps: Report a snapshot of the current processes. - meminfo: Report the memory status of the LoadMaster. - ifconfig: Return the details of the network interfaces. - netstat: Return the following information: - Active Internet connections, servers and established (IPv4/IPv6) - Kernel IP routing table (IPv4/IPv6) - IPv4/IPv6 packet filter - interrupts: Lists the number of interrupts per CPU per I/O device. - partitions: Partition block allocation information. - cpuinfo: Return the details of the LoadMaster CPU(s). - df: Display the device name, total blocks, total disk space, used disk space, available disk space and mount points on the LoadMaster file system. - lspci: Returns information about PCI buses in the system and devices connected to them. - lsmod: Show the status of modules in the Linux Kernel - slabinfo: Return statistics for frequently used objects in the Linux kernel (buffer heads, inodes, dentries and so on). String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Get-LmDebugInformation -Param ps Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. F UID PID PPID PRI NI VSZ RSS WCHAN STAT TTY TIME COMMAND 4 0 1 0 20 0 4356 1376 - Ss ? 0:14 init [2] 1 0 2 0 20 0 0 0 - S ? 0:00 [kthreadd] 1 0 3 2 20 0 0 0 - S ? 0:01 [ksoftirqd/0] 1 0 4 2 20 0 0 0 - S ? 0:00 [kworker/0:0] 1 0 5 2 0 -20 0 0 - S< ? 0:00 [kworker/0:0H] 1 0 7 2 20 0 0 0 - S ? 1:28 [rcu_sched] 1 0 8 2 20 0 0 0 - S ? 0:00 [rcu_bh] 1 0 9 2 -100 - 0 0 - S ? 0:04 [migration/0] 5 0 10 2 -100 - 0 0 - S ? 0:04 [watchdog/0] 5 0 11 2 -100 - 0 0 - S ? 0:05 [watchdog/1] 1 0 12 2 -100 - 0 0 - S ? 0:04 [migration/1] 1 0 13 2 20 0 0 0 - S ? 0:02 [ksoftirqd/1] 1 0 15 2 0 -20 0 0 - S< ? 0:00 [kworker/1:0H] 1 0 16 2 0 -20 0 0 - S< ? 0:00 [netns] 1 0 17 2 0 -20 0 0 - S< ? 0:00 [perf] 1 0 18 2 20 0 0 0 - S ? 0:02 [khungtaskd] 1 0 19 2 0 -20 0 0 - S< ? 0:00 [writeback] 1 0 20 2 0 -20 0 0 - S< ? 0:00 [crypto] 1 0 21 2 20 0 0 0 - S ? 1:30 [kworker/0:1] 1 0 22 2 0 -20 0 0 - S< ? 0:00 [bioset] 1 0 23 2 0 -20 0 0 - S< ? 0:00 [kblockd] 1 0 24 2 0 -20 0 0 - S< ? 0:00 [ata_sff] 1 0 26 2 20 0 0 0 - S ? 0:00 [kswapd0] 1 0 27 2 0 -20 0 0 - S< ? 0:00 [vmstat] 1 0 28 2 20 0 0 0 - S ? 0:00 [fsnotify_mark] 1 0 43 2 0 -20 0 0 - S< ? 0:00 [acpi_thermal_pm] 1 0 45 2 0 -20 0 0 - S< ? 0:00 [bioset] 1 0 46 2 0 -20 0 0 - S< ? 0:00 [bioset] 1 0 47 2 0 -20 0 0 - S< ? 0:00 [bioset] 1 0 48 2 0 -20 0 0 - S< ? 0:00 [bioset] 1 0 49 2 0 -20 0 0 - S< ? 0:00 [bioset] 1 0 50 2 0 -20 0 0 - S< ? 0:00 [bioset] 1 0 51 2 0 -20 0 0 - S< ? 0:00 [bioset] 1 0 52 2 0 -20 0 0 - S< ? 0:00 [bioset] 1 0 53 2 0 -20 0 0 - S< ? 0:00 [bioset] 1 0 54 2 0 -20 0 0 - S< ? 0:00 [bioset] 1 0 55 2 0 -20 0 0 - S< ? 0:00 [bioset] 1 0 56 2 0 -20 0 0 - S< ? 0:00 [bioset] 1 0 57 2 0 -20 0 0 - S< ? 0:00 [bioset] 1 0 58 2 0 -20 0 0 - S< ? 0:00 [bioset] 1 0 59 2 0 -20 0 0 - S< ? 0:00 [bioset] 1 0 60 2 0 -20 0 0 - S< ? 0:00 [bioset] 1 0 61 2 0 -20 0 0 - S< ? 0:00 [bioset] 1 0 62 2 0 -20 0 0 - S< ? 0:00 [bioset] 1 0 63 2 0 -20 0 0 - S< ? 0:00 [bioset] 1 0 64 2 0 -20 0 0 - S< ? 0:00 [bioset] 1 0 65 2 0 -20 0 0 - S< ? 0:00 [bioset] 1 0 66 2 20 0 0 0 - S ? 0:48 [kworker/1:1] 1 0 67 2 0 -20 0 0 - S< ? 0:00 [bioset] 1 0 68 2 0 -20 0 0 - S< ? 0:00 [bioset] 1 0 69 2 0 -20 0 0 - S< ? 0:00 [bioset] 1 0 70 2 0 -20 0 0 - S< ? 0:00 [fc_exch_workque] 1 0 71 2 0 -20 0 0 - S< ? 0:00 [fc_rport_eq] 1 0 72 2 0 -20 0 0 - S< ? 0:00 [fcoethread/0] 1 0 73 2 0 -20 0 0 - S< ? 0:00 [fcoethread/1] 1 0 74 2 0 -20 0 0 - S< ? 0:00 [fnic_event_wq] 1 0 75 2 0 -20 0 0 - S< ? 0:00 [fnic_fip_q] 1 0 76 2 20 0 0 0 - S ? 0:00 [scsi_eh_0] 1 0 77 2 0 -20 0 0 - S< ? 0:00 [scsi_tmf_0] 1 0 78 2 0 -20 0 0 - S< ? 0:00 [vmw_pvscsi_wq_0] 1 0 79 2 0 -20 0 0 - S< ? 0:00 [bioset] 1 0 95 2 0 -20 0 0 - S< ? 0:00 [kpsmoused] 1 0 96 2 20 0 0 0 - S ? 0:00 [kworker/1:2] 1 0 97 2 0 -20 0 0 - S< ? 0:00 [ipv6_addrconf] 1 0 98 2 0 -20 0 0 - S< ? 0:00 [deferwq] 1 0 99 2 0 -20 0 0 - S< ? 0:00 [ext4-rsv-conver] 1 0 142 2 0 -20 0 0 - S< ? 0:00 [kworker/0:1H] 5 3 261 1 20 0 26816 1444 - Ss ? 0:09 /sbin/nscd 1 0 279 2 0 -20 0 0 - S< ? 0:00 [kworker/1:1H] 1 0 297 2 0 -20 0 0 - S< ? 0:00 [loop0] 5 0 636 1 20 0 4392 1780 - Ss ? 0:09 /usr/sbin/syslogd 5 0 640 1 20 0 4488 1372 - Ss ? 0:00 /usr/sbin/klogd -c 7 4 0 668 1 20 0 18488 4612 - Ss ? 0:00 /usr/sbin/sshd 1 0 677 1 20 0 15228 1564 - Ss ? 0:04 /usr/sbin/cron -L 0 1 0 692 2 0 -20 0 0 - S< ? 0:00 [l7comp] 4 0 727 1 20 0 4464 1904 - S ? 0:20 /sbin/l7d -C 0 -N 0 -0 eth0 -G 1 -T 2 -l 0 0 729 1 20 0 4196 644 - S ? 0:02 /sbin/l7log 0 0 732 1 20 0 9536 2660 - S ? 0:00 /bin/bash /sbin/startDaemon /sbin/ssomgr -C 0 0 0 761 1 20 0 9536 2648 - S ? 0:00 /bin/bash /sbin/startDaemon /sbin/stats -C 0 4 0 767 761 20 0 11688 1896 - S ? 3:11 /sbin/stats -C 0 0 0 784 1 20 0 11868 4984 - S ? 26:01 /bin/bash /usr/local/bin/rrd-upd-all.sh 1 0 793 1 20 0 6508 124 - S ? 0:40 inotifywait -d -o/tmp/metrics.evts -e MOVED_TO --format %T %f %e --timefmt %s /var/ lib/metrics 0 0 833 1 20 0 9536 2636 - S ? 0:00 /bin/bash /sbin/startDaemon /sbin/ocspd 4 0 842 833 20 0 14060 3576 - S ? 0:03 /sbin/ocspd 0 0 860 1 20 0 6728 1668 - S ? 0:02 /sbin/httpd -port 8080 -address 127.0.0.1 0 0 907 1 20 0 9540 2660 - S ? 0:00 /bin/bash /sbin/startDaemon /sbin/wafd -C 0 -M 4 4 0 916 907 20 0 52488 4212 - S ? 0:00 /sbin/wafd -C 0 -M 4 0 0 949 1 20 0 9536 2656 - S ? 0:00 /bin/bash /sbin/startDaemon /sbin/l4d -C 0 4 0 957 949 12 -8 17520 3252 - S< ? 0:35 /sbin/l4d -C 0 0 0 1000 1 20 0 4672 1304 - S ? 0:04 /sbin/binddb -C 0 0 0 1002 1 20 0 5440 704 - S ? 0:13 /sbin/geocheck -C 0 4 0 1004 732 20 0 50372 6324 - S ? 0:12 /sbin/ssomgr -C 0 5 0 1008 1 20 0 66652 50156 - Ss ? 0:10 /sbin/named 4 0 1045 1 20 0 116464 4184 - Sl ? 13:51 /usr/bin/vmtoolsd 4 0 1078 1 20 0 8680 1648 - Ss+ tty1 0:00 /sbin/mingetty --noclear tty1 4 0 1079 1 20 0 8680 1652 - Ss+ tty2 0:00 /sbin/mingetty tty2 4 0 1080 1 20 0 8680 1656 - Ss+ tty3 0:00 /sbin/mingetty tty3 4 0 1081 1 20 0 8680 1724 - Ss+ tty4 0:00 /sbin/mingetty tty4 4 0 1082 1 20 0 8680 1652 - Ss+ tty5 0:00 /sbin/mingetty tty5 4 0 1083 1 20 0 8680 1672 - Ss+ tty6 0:00 /sbin/mingetty tty6 4 0 1084 1 20 0 4360 1660 - Ss+ ttyS0 0:00 /sbin/agetty -L -f /etc/issue.serial 115200 57600 38400 19200 9600 ttyS0 vt100 1 0 1272 2 20 0 0 0 - S ? 0:00 [kworker/u4:2] 5 0 1304 916 20 0 59144 6192 - Sl ? 0:00 /sbin/wafd -C 0 -M 4 0 0 1356 1 20 0 9540 2664 - S ? 0:00 /bin/bash /sbin/startDaemon /sbin/sslproxy -T 10 -P 443 -r 127.0.0.1:8080 -F IPADDR _0 -F ADDITIONAL_0 -c /one4net/certs/.cert.pem -E 3 -V /usr/lib/ssl/certs 4 0 1365 1356 20 0 14460 5300 - S ? 0:38 /sbin/sslproxy -T 10 -P 443 -r 127.0.0.1:8080 -F IPADDR_0 -F ADDITIONAL_0 -c /one4n et/certs/.cert.pem -E 3 -V /usr/lib/ssl/certs 1 0 4024 860 20 0 6740 116 - S ? 0:00 /sbin/httpd -port 8080 -address 127.0.0.1 4 3 4025 4024 20 0 7828 948 - S ? 0:00 /bin/access -C 0 -F 0 -H 3 0 3 4034 4025 20 0 11088 4152 - S ? 0:00 /bin/sh /etc/rc.d/config ps 0 3 4038 4034 20 0 7140 792 - R ? 0:00 /bin/ps alxwww 1 0 14514 2 20 0 0 0 - S ? 0:00 [kworker/u4:0] 1 0 27228 2 10 -10 0 0 - S< ? 0:11 [l7s 1] 1 0 27229 2 20 0 0 0 - S ? 0:10 [l7flow 1] 1 0 27230 2 20 0 0 0 - S ? 0:11 [l7flow 1] 1 0 27231 2 20 0 0 0 - S ? 0:12 [l7flow 1] 1 0 27232 2 20 0 0 0 - S ? 0:11 [l7flow 1] 1 0 27233 2 20 0 0 0 - S ? 0:11 [l7flow 1] 1 0 27235 2 20 0 0 0 - S ? 0:11 [l7flow 1] 1 0 27236 2 20 0 0 0 - S ? 0:10 [l7flow 1] 1 0 27238 2 20 0 0 0 - S ? 0:11 [l7flow 1] 0 0 29434 1 20 0 9540 2676 - S ? 0:00 /bin/bash /sbin/startDaemon /sbin/vsslproxy -C 0 -A -D /one4net/certs -V /usr/lib/s sl/certs -T 10000 -i 660 -t 65536 -N 5 -E 2 4 0 29439 29434 20 0 16108 2856 - S ? 0:04 /sbin/vsslproxy -C 0 -A -D /one4net/certs -V /usr/lib/ssl/certs -T 10000 -i 660 -t 65536 -N 5 -E 2 5 0 29479 29439 10 -10 282536 4564 - S<l ? 0:00 /sbin/vsslproxy -C 0 -A -D /one4net/certs -V /usr/lib/ssl/certs -T 10000 -i 660 -t 65536 -N 5 -E 2 Get-LmHAConfiguration Allows you to view the values of High Availability (HA) options. Get LmHAConfiguration Retrieve the HA settings. Get-LmHAConfiguration LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Get-LmHAConfiguration LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String To get the HA status, run the following command: Get-LmParameter -Param HAStatus To retrieve the HACheck parameter, run the following command: Get-NetworkInterface -------------------------- Example -------------------------- PS C:\> Get-LmHAConfiguration Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed; Data=} Return Code..: 200 Response.....: Command successfully executed hamode : HA Second hatimeout : 3 hawait : 0 havhid : 0 haprefered : No Preferred Host haif : 0 hal4update : no hal7update : no Get-LmHAMode Retrieve the High Availability (HA) mode. Get LmHAMode The HA mode is one of the following options: 0 – HA mode disabled 1 – HA 1 mode 2 – HA 2 mode 3 – System is using cloud HA 4 – System is in a cluster Get-LmHAMode LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Get-LmHAMode LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Get-LmHAMode Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed; Data=} Return Code..: 200 Response.....: Command successfully executed HaMode : 2 HaDescription : HA Second Get-LmIPConnectionLimit Displays a list of client IP address limiters. Get LmIPConnectionLimit Displays a list of client IP address limiters. Get-LmIPConnectionLimit LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Get-LmIPConnectionLimit LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Get-LmIPConnectionLimit Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Address Mask Limit ------- ---- ----- 10.64.55.22 32 155 Get-LmNetworkInterface Retrieves details for the LoadMaster network interface. Get LmNetworkInterface Returns details about the LoadMaster network interface, such as the speed, name and Id number. Get-LmNetworkInterface LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Get-LmNetworkInterface LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Get-LmNetworkInterface Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Data field...: @{Interface=} Param........: @{Id=0; Name=eth0; speed=10000; inbytes=11187190; inerrs=0; indrops=0; outbytes=21653858; outerrs=0; outdrops=0; link=up; lastchange=1492 686160} Id : 0 Name : eth0 speed : 10000 inbytes : 11187190 inerrs : 0 indrops : 0 outbytes : 21653858 outerrs : 0 outdrops : 0 link : up lastchange : 1492686160 Get-LmParameter A large number of LoadMaster parameters can be retrieved using the Get-LmParameter command. Get LmParameter Below is a list of the parameters that can be retrieved using the Get-LmParameter command. The parameters are grouped and ordered by WUI section. ----------------- WUI Section: Home ----------------- version Retrieves the LoadMaster firmware version. serialnumber The serial number of the LoadMaster. boottime The time at which the LoadMaster last booted. activetime When using non-HA mode, the activetime is the same as the boottime. When in HA mode, the active time is the time at which the LoadMaster last became the master unit. The active time will be zero if the LoadMaster is in slave mode. -------------------------------------------------------------------------- WUI Section: Virtual Services > View/Modify Services > Advanced Properties -------------------------------------------------------------------------- addvia Specifies which headers should be added to the HTTP stream. The parameter takes the following arguments: 0 = Legacy Operation 1 = X-Forwarded-For 2 = None 3 = X-Client-Side 4 = X-Client-Side No Via 5 = X-Forwarded-For No Via 6 = Via Only ------------------------------------ WUI Section: Certificates & Security ------------------------------------ localcert This parameter is only relevant when using HA. ------------------------------------------------------- WUI Section: Certificates & Security > SSL Certificates ------------------------------------------------------- admincert The certificate used, if any, for the administrative interface. ---------------------------------------------------- WUI Section: Certificates & Security > Remote Access ---------------------------------------------------- admingw When administering the LoadMaster from a non-default interface, this option allows the user to specify a different default gateway for administrative traffic only. sshaccess Specify over which addresses remote administrative SSH access to the LoadMaster is allowed. sshport Specify the port used to access the LoadMaster via the SSH protocol. wuiaccess Enables or disables access to the Web User Interface (WUI). wuiiface Specifies the interface for the WUI. wuiport Specifies the port to access the WUI. sshiface Specify the addresses over which remote administrative SSH access to the LoadMaster is allowed. enableapi Enables the programmable command API Interface. Note: If this is disabled, the API will no longer be accessible. adminclientaccess Valid values for this parameter are: 0 – Password only access (default) 1 – Password or client certificate 2 – Client certificate required 3 – Client certificate required (verify via OCSP) This parameter is only relevant if Session Management is enabled. For further information on Session Management and on the Admin Client Access option, refer to the User Management, Feature Description on the KEMP documentation page: www.kemptechnologies.com/documentation tethering Allow the LoadMaster to regularly check the KEMP website for new software versions. 0 - Disabled 1 - Enabled geoclients Set the addresses of the GEO LoadMasters which can retrieve service status information from the LoadMaster. geopartners Set the IP address of the GEO LoadMaster partner(s). These GEO LoadMasters will keep their DNS configurations in sync. Note: Before partnering GEO LoadMasters, a backup should be taken of the relevant GEO LoadMaster which has the correct/preferred configuration. This backup should then be restored to the other LoadMasters that will be partnered with the original LoadMaster. multihomedwui Allow WUI access from multiple interfaces. Apart from the main administrative interface, each interface can then be enabled to allow WUI access. SSHPreAuth Set the SSH pre-authentication banner, which is displayed before the login prompt when logging in via SSH. Space characters should be escaped by entering %20. This field accepts up to 5,000 characters. Anything past the 5,000 character limit will not be displayed. sessioncac If this parameter is enabled, the LoadMaster will also check for a Common Access Card (CAC) certificate when a user is logging on to the WUI. 0 - Disabled 1 - Enabled -------------------------------------------------------------------------------- WUI Section: Certificates & Security > Remote Access > WUI Authorization Options -------------------------------------------------------------------------------- sessionauthmode Specifies the authentication mode for the LoadMaster. Refer to the following table for values: | RADIUS | LDAP | Local Value | Authent. Author. | Authent. | Authent. Author. 7 | No No | No | No No 263 | Yes No | No | Yes Yes 775 | Yes Yes | No | Yes Yes 23 | No No | Yes | Yes Yes 22 | No No | Yes | No Yes 788 | Yes Yes | Yes | No No 790 | Yes Yes | Yes | No Yes 791 | Yes Yes | Yes | Yes Yes 789 | Yes Yes | Yes | Yes No 773 | Yes Yes | No | Yes No 262 | Yes No | No | No Yes 774 | Yes Yes | No | No Yes 772 | Yes Yes | No | No No 278 | Yes No | Yes | No No 279 | Yes No | Yes | Yes Yes sessionlocalauth Enables or disables local authentication. radiusbackupport Specifies the TCP port for the backup RADIUS server. radiusbackupsecret Specifies the password (secret) to the backup RADIUS server. radiusbackupserver Specifies the backup RADIUS server to use for authentication. radiusport Specifies the TCP port for communication to the RADIUS server. radiussecret Specifies the password (secret) to the RADIUS server. radiusserver Specifies the RADIUS server to use for authentication. radiusrevalidateinterval Specifies when to revalidate the authentication to the RADIUS server. ldapserver Specifies the LDAP server to use for authentication. ldapbackupserver Specifies the backup LDAP server for authentication. ldapsecurity Specifies the security mode for LDAP authentication. ldaprevalidateinterval Specifies how often to revalidate the authentication to the LDAP server. ------------------------------------------------------- WUI Section: Certificates & Security > Admin WUI Access ------------------------------------------------------- sessionidletime Specifies the number of seconds that the WUI can be idle before logging the user out. This can be set from 60 to 86400 seconds. sessionmaxfailattempts Number of failed attempts before locking the user account. This can be set from 1 to 999. sessioncontrol Enables or disables session control. sessionbasicauth If the SessionControl and SessionBasicAuth parameters are both enabled, there are two levels of authentication enforced in order to access the LoadMaster WUI. The initial level is Basic Authentication where users log in using the bal or user logins, which are default usernames defined by the system. sessionconcurrent Limit the maximum number of concurrent connections a single user can have. Range: 0 to 9. A value of 0, means logins are unlimited. geosshport The port over which GEO LoadMasters will communicate with on another. WUIPreAuth Set the pre-authentication click through banner which will be displayed before the LoadMaster login page. This parameter can contain plain text or HTML code. The field cannot contain JavaScript. This field accepts up to 5,000 characters. Anything past the 5,000 character limit will not be displayed. WUITLSProtocols Specify whether or not it is possible to connect to the LoadMaster WUI using the following protocols; SSLv3, TLS1.0, TLS1.1 or TLS1.2. The protocols can be enabled and disabled using a bitmask value in the range 0 to 14. Refer to the table below to find out what number corresponds to which settings. Number | SSLv3 | TLS1.0 | TLS1.1 | TLS1.2 0 | Enabled | Enabled | Enabled | Enabled 1 | Disabled | Enabled | Enabled | Enabled 2 | Enabled | Disabled | Enabled | Enabled 3 | Disabled | Disabled | Enabled | Enabled 4 | Enabled | Enabled | Disabled | Enabled 5 | Disabled | Enabled | Disabled | Enabled 6 | Enabled | Disabled | Disabled | Enabled 7 | Disabled | Disabled | Disabled | Enabled 8 | Enabled | Enabled | Enabled | Disabled 9 | Disabled | Enabled | Enabled | Disabled 10 | Enabled | Disabled | Enabled | Disabled 11 | Disabled | Disabled | Enabled | Disabled 12 | Enabled | Enabled | Disabled | Disabled 13 | Disabled | Enabled | Disabled | Disabled 14 | Enabled | Disabled | Disabled | Disabled WUICipherset Specify the cipher set to use for the LoadMaster WUI. The valid values are below: - Default - Default_NoRc4 - BestPractices - Intermediate_compatibility - Backward_compatibility - WUI - FIPS - Legacy - <NameOfCustomCipherSet> Specify the cipher set to use for the LoadMaster WUI. --------------------------------------------------------- WUI Section: Certificates & Security > OCSP Configuration --------------------------------------------------------- OCSPPort The port of the OCSP server. OCSPUseSSL Specify whether or not to use SSL to connect to the OCSP server. OCSPOnServerFail Treat an OCSP server connection failure of timeout as if the OCSP server had returned a valid response, i.e. treat the client certificate as valid. OCSPServer The address of the OCSP server. OCSPUrl The URL to access on the OCSP server. SSLStapling Enable this parameter to enable the LoadMaster to respond to OCSP stapling requests. If a client connects using SSL and asks for an OCSP response, this is returned. Only Virtual Service certificates are validated. The system holds a cache of OCSP responses that are sent back to the client. This cache is maintained by the OCSP daemon. When the OCSP daemon sends a request to the server, it uses the name specified in the certificate (in the Authority Information Access field). If it cannot resolve this name, then it uses the default OCSP server specified in the OCSPServer parameter. SSHRefreshInterval Specify how often the LoadMaster should refresh the OCSP stapling information. The OCSP daemon caches the entry for up to the amount of time specified here, after which it is refreshed. Valid values range from 3600 (1 hour (default)) to 604800 seconds (7 days). -------------------------------------------------------------- WUI Section: System Configuration > Network Setup > Interfaces -------------------------------------------------------------- mcast The network interface used for multicast traffic which is used to synchronize Layer 4 and Layer 7 traffic when Inter HA Updates are enabled. ---------------------------------------------------------------------------- WUI Section: System Configuration > Network Setup > Host & DNS Configuration ---------------------------------------------------------------------------- dnssecclient Enable or disable DNSSEC client capabilities on the LoadMaster. At least one name server must be configured before DNSSEC can be enabled. After changing this setting, the LoadMaster must be rebooted for the change to be applied. Once the setting is changed, it cannot be changed again until the LoadMaster has been rebooted. If using HA, please set the parameter on both devices separately. 0 = Disabled 1 = Enabled DNSNamesEnable When this option is enabled, the LoadMaster automatically attempts to update any changed DNS names (based on the update interval): - If the address is not found, or if it is the same as before – nothing is done (except a log entry is generated). - If the address is different, the Real Server entry is updated with the new address, if possible. - If the new address is invalid for some reason, for example if it is a non-local address and the nonlocalrs option is disabled, no changes are made and a log is generated. dnsupdateinterval Set the update interval for DNS entries. Valid values range from 1-60 (minutes). The default value is 60. dnsreloadonerror If this parameter is enabled, DNS entries are reloaded when health checks have errors and an FQDN is associated with the Real Server IP address. namserver The DNS server the LoadMaster will use for name resolution. Setting this parameter to an empty string will delete the name servers. The last remaining name server cannot be deleted if the dnssecclient parameter is enabled. This parameter has been deprecated and replaced with the nameserver parameter. nameserver The DNS server the LoadMaster will use for name resolution. Setting this parameter to an empty string will delete the name servers. The last remaining name server cannot be deleted if the dnssecclient parameter is enabled. ha1hostname When using the LoadMaster in HA mode, this is the host name of the first node. If the LoadMaster is not in HA mode, then this will return an error. ha2hostname When using the LoadMaster in HA mode, this is the host name of the second node. If the LoadMaster is not in HA mode, then this will return an error. hostname The hostname assigned to the LoadMaster. searchlist The domain suffix search list when performing DNS resolution. ------------------------------------------------------------------- WUI Section: System Configuration > Network Setup > Default Gateway ------------------------------------------------------------------- dfltgw Specify the IPv4 default gateway that is to be used for communicating with the internet. dfltgwv6 Specify the IPv6 default gateway that is to be used for communicating with the internet. -------------------------------------------------------------------------- WUI Section: System Configuration > System Administration > Backup/Restore -------------------------------------------------------------------------- backupday For scheduled backups, this parameter specifies the "day" number (0-7). backupenable Specifies if scheduled backups are enabled. backuphost Specifies the host to save the backup file to. backuphour For scheduled backups, this parameter specifies the "hour" number (0-23). backupminute For scheduled backups, this parameter specifies the "minute" number (0-59). backupsecure Specify the file transfer method for automated backups. 0 – Ftp (insecure) 1 – scp (secure) backuppassword Specifies the password for the user account that has access to save the backup file. backuppath Specifies the path on the remote host for saving the backup file. backupuser Specifies the user account that has access to save the backup file. --------------------------------------------------------------------- WUI Section: System Configuration > System Administration > Date/Time --------------------------------------------------------------------- ntphost Specifies the time synchronization server. Multiple hosts can be specified using a space-separated list. ntpkeytype Specify the NTP Key Type. The valid values are SHA-1 (SHA) and MD5 (M). The values must be specified in uppercase. ntpkeysecret The NTP shared secret string. The NTP secret can be a maximum of 40 characters long. If the secret is more than 20 characters long, it is treated as a hex string. Setting this value to an empty string will disable the NTPv4 feature. ntpkeyid The NTP key ID. Valid values range from 1 to 99. timezone Specifies the time zone of the LoadMaster. time Sets the time of the LoadMaster. ------------------------------------------------------------------- WUI Section: System Configuration > Logging Options > Debug Options ------------------------------------------------------------------- irqbalance The purpose of IRQBalance is distribute hardware interrupts across processors on a multiprocessor system. This should only be enabled after consultation with KEMP Technical Support. backupnetstat By default, the LoadMaster includes a Netstat output in backups taken. When this is included, backups take longer to complete. You can stop the Netstat output from being included by disabling this parameter. linearesplogs By default, the LoadMaster deletes older log files. If this parameter is enabled, older log files will no longer be deleted. If the filesystem fills up, further access via the LoadMaster is blocked. netconsole Netconsole is a kernel module which logs kernel printk messages over UDP allowing debugging of problems where disk logging fails. If directed by a KEMP support engineer, the syslog daemon on a specific host will receive all critical kernel messages. This can help in understanding why a LoadMaster is rebooting. netconsoleinterface The interface which hosts the Netconsole. -------------------------------------------------------------------- WUI Section: System Configuration > Logging Options > Syslog Options -------------------------------------------------------------------- syslogemergency Use this option to set the host(s) which will receive Emergency events only. Entries must be comma-separated. Up to 10 entries are supported in total for all levels. syslogcritical Use this option to set the host(s) which will receive Emergency and Critical events. Entries must be comma-separated. Up to 10 entries are supported in total for all levels. syslogerror Use this option to set the host(s) which will receive Emergency, Critical and Error events. Entries must be comma-separated. Up to 10 entries are supported in total for all levels. sysloginfo Use this option to set the host(s) which will receive Emergency, Critical, Error and Warning events. Entries must be comma-separated. Up to 10 entries are supported in total for all levels. syslognotice Use this option to set the host(s) which will receive Emergency, Critical, Error, Warning and Notice events. Entries must be comma-separated. Up to 10 entries are supported in total for all levels. syslogwarn Use this option to set the host(s) which will receive All events. Entries must be comma-separated. Up to 10 entries are supported in total for all levels. syslogport Specify the port that syslog messages are sent to on the receiving hosts. ------------------------------------------------------------------ WUI Section: System Configuration > Logging Options > SNMP Options ------------------------------------------------------------------ snmpenable Enable or disable SNMP. snmpV3enable Enable SNMP V3. 0 = Disabled 1 = Enabled snmpv3user Specify the username. snmpv3userpasswd Specify the user password. snmpAuthProt Specify the relevant authentication protocol: - MD5 - SHA SHA is a more secure protocol. snmpPrivProt Specify the relevant privacy protocol: - DES - AES AES is a more secure protocol. snmpcontact Specify the contact address that is sent in SNMP responses. snmpcommunity Specify the SNMP community string. snmplocation Specify the location that is sent in SNMP responses. snmpHaTrap Send SNMP traps from the shared IP address. This option is only available when the LoadMaster is in HA mode. snmpv1sink Specify the sink address for SNMP type 1 traps. snmpv2sink Specify the sink address for SNMP type 2 traps. snmpclient Specify the list of machines that can access the SNMP subsystem. If no clients are specified, then anyone can access SNMP. snmptrapenable Enable the generation of SNMP events whenever a significant event occurs. ------------------------------------------------------------------- WUI Section: System Configuration > Logging Options > Email Options ------------------------------------------------------------------- emailuser The user account with access to send mail messages. emaildomain The domain, if required, for the user account authentication. emailpassword The email user's password. emailserver The host name or address of the SMTP server to send mail messages through. emailsslmode Specify the type of security protocol that should be used on the connection: 0 = None 1 = STARTTLS, if available 2 = STARTTLS 3 = SSL/TLS emailport The TCP port on which your mail server accepts connections (usually 25). emailcritical The email address to receive critical messages. emailemergency The email address to receive emergency messages. emailerror The email address to receive error messages. emailinfo The email address to receive informational messages. emailnotice The email address to receive notices. emailwarn The email address to receive warnings. emailenable Enables or disables the email logging options. ------------------------------------------------------------------- WUI Section: System Configuration > Logging Options > SDN Log Files ------------------------------------------------------------------- sdnstatsmode There are two modes that can be used to gather the SDN statistics. The modes are described below: • Mode 1: When set to mode 1, the statistics are taken from the switch port that is connected to the server and the statistics are relayed back to the LoadMaster. • Mode 2: When set to mode 2, the information is taken from all of the switch ports along the path. ------------------------------------------------------------------------ WUI Section: System Configuration > Miscellaneous Options > WUI Settings ------------------------------------------------------------------------ hoverhelp Enables or disables hover help in the WUI. motd Sets the Message Of The Day (MOTD) for the web user interface. Either plain text or a text file can be used. The maximum number of characters is 5,000. An error will be displayed if the MOTD is greater than 5,000 characters. wuidisplaylines Specifies the number of display lines in the WUI. This can be set from 10 to 100. ---------------------------------------------------------------------------- WUI Section: System Configuration > Miscellaneous Options > L7 Configuration ---------------------------------------------------------------------------- transparent When using Layer 7, when this is enabled the connection arriving at the Real Server appears to come directly from the client. Alternatively, the connection can be non-transparent which means that the connections at the Real Server appear to come from the LoadMaster. alwayspersist This parameter also accepts no and yes as valid values. No and Yes correspond to 0 and 1 respectively. expect100 By default, the L7 module only waits for 100-Continue replies if it sees an Expect-100 header, use RFC-2616 Compliant. If the system will always wait for 100 Continue messages, use Require 100-Continue. If the client will always send the POST data even if a 100 Continue message is not sent, use RFC-7231 Compliant instead. localbind In very high load situations, local port exhaustion can occur. Enabling this option allows the setting of alternate source addresses. This can be used to expand the number of available local ports. addcookieport When using the LoadMaster behind a NATing gateway, all client addresses are the same. To create individual cookies the remote port can also be added to the cookie. Enabling this option when not needed wastes resources. addforwardheader This option, only available when L7 Transparency is disabled, allows the addition of either X-ClientSide or X-Forwarded For to the HTTP header. authtimeout The duration (in seconds) that a connection remains open for while authentication is ongoing. This value can be between 30 and 300. clienttokentimeout The duration (in seconds) to wait for the client token while the process of authentication is ongoing (used for RSA SecurID and RADIUS authentication). The default value for this parameter is 120. finalpersist When a Real Server is disabled, the sessions persisting on that Real Server continue to be served until the Drain Time has expired or until no more sessions are being handled by the Real Server. No new sessions will be handled by the Real Server. Valid values include 0, and 60 to 86400. rfcconform By default, the LoadMaster conforms to the RFC when parsing HTTP headers. Disabling this will allow interworking with some broken browsers. dropatdrainend If enabled, all open connections to disabled Real Servers will be dropped at the end of the Real Servers Drain Stop Time or immediately if there are no Persist entries associated with the Real Server. droponfail By default, existing connections are not closed if a Real Server fails. Enabling this feature causes all connections to be immediately dropped on Real Server failure. closeonerror When enabled, the LoadMaster will always close the client connection when it sends back an error response. For Example, this changes the behaviour of the LoadMaster when sending back a 304 File not changed message after receiving an If-Modified-Since HTTP header. rsarelocal When checking to see if a client is on the local subnet, also check to see if the client is actually a Real Server. slowstart When using the Least Connection (or Weighted Least Connection) scheduling method, specify the time (in seconds) over which the load to a Real Server which has just come online will be throttled. ShareSubVSPersist By default, each SubVS has an independent persistence table. Enabling this parameter will allow the SubVS to share this information. logsplitinterval When using Log Insight Scheduling this is the number of messages which are received on a connection before the stream is rescheduled. The default value is 10. allowemptyposts By default the LoadMaster blocks POSTs that do not contain a Content-Length or Transfer-Encoding header to indicate the length of the requests payload. When this parameter is set to true, such requests are assumed to have no payload data and are therefore not rejected. forcefullrsmatch By default, when the LoadMaster is trying to locate a Real Server for use with content switching, it tries to use the same Real Server as currently selected, even if the port is not the same. If this parameter is enabled - the port is also compared. AllowEmptyHttpHeaders By default, if the LoadMaster is processing HTTP headers, it will ignore HTTP headers that have empty content. This can break some SOAP Services even though it is against the HTTP RFCs. Enabling this option will allow these empty headers through. loguseragent When enabled, the User Agent header field is added to the User Logs. 0 - Disabled 1 - Enabled --------------------------------------------------------------------------- WUI Section: System Configuration > Miscellaneous Options > Network Options --------------------------------------------------------------------------- snat Enabling this options allows the LoadMaster to NAT connections from the Real Servers to the internet. routefilter When enabled, this option only accepts IP frames from a host over the interface where the routing algorithm would route frames to the host. This is known as strict source route validation. subnetoriginating When transparency is disabled for a Virtual Service, the source IP address of connections to Real Servers is the Virtual Service. When enabled, the source IP address is the local address of the LoadMaster. If the Real Server is on a subnet, the subnet address of the LoadMaster will be used. nonlocalrs Enable this option to allow assigning non-local Real Servers to Virtual Services. multigw Use this option to enable the ability to move the default gateway to a different interface. conntimeout Specify the timeout value for the check request. Range: 4-60 tcptimestamp The LoadMaster can include a timestamp in the SYN when connecting to Real Servers. Only enable this option when requested to from KEMP Support. resetclose When enabled, the LoadMaster will close its connection to the Real Servers by using TCP RESET instead of the normal close handshake. keepalive By default, the system uses TCP keepalives to check for failed clients. Enabling this option improves the reliability of older TCP connections (SSH sessions). Not normally required for normal HTTP/HTTPS services. allowupload The LoadMaster has been optimized with HTTP workloads in mind. Enabling this option allows non HTTP uploads to work correctly. subnetorigin When transparency is disabled for a Virtual Service, the source IP address of connections to Real Servers is the Virtual Service. When enabled, the source IP address is the local address of the LoadMaster. If the Real Server is on a subnet, the subnet address of the LoadMaster will be used. onlydefaultroutes Enable this option to force traffic from Virtual Services, which have default route entries set, to be routed to the interface where the Virtual Service’s default route is located. http_proxy This option allows clients to specify the HTTP(S) proxy server and port the LoadMaster will use to access the internet. dhkeysize Select the strength of the key used in the Diffe-Hellman key exchanges. If this value is changed, a reboot is required in order to use the new value. The default value is 2048 Bits. sslrenegotiate By default, the LoadMaster allows a client to automatically renegotiate during an SSL transaction. Disabling this parameter causes SSL connections to terminate if a renegotiation is requested by the client. sslforceserververify By default, when re-encrypting traffic the LoadMaster does not check the certificate provided by the Real Server. Enabling this option forces the LoadMaster to verify that the certificate on the Real Server is valid, that is, the certificate authority and expiration are OK. This includes all intermediate certificates. tcpnorecycle Enable this option to revert to the legacy mode of reusing TCP timewait connections. Note: Only enable this after consulting with KEMP Support. ----------------------------------------------------------------------------- WUI Section: System Configuration > Miscellaneous Options > AFE Configuration ----------------------------------------------------------------------------- paranoia Sets the sensitivity of IDS detection. cachesize Specifies the cache size. hostcache Enable or disable using the host cache. limitinput Limit the number of connections. L7LimitInput This setting limits the default maximum number of connection attempts (per second) from a specific host. ------------------------------------------------------------------------- WUI Section: System Configuration > Miscellaneous Options > HA Parameters ------------------------------------------------------------------------- hastatus The status of a HA or cluster unit. This is a read only parameter and cannot be set. Possible values are: Normal HA: Active, Standby, Passive (all as expected). Cloud HA: Active, Standby, Passive (if status not yet set). Cluster: Active (if master), Standby (if slave), Passive (if disabled). hatimeout The time the master must be unavailable before a switchover occurs. Allowed Values: 1-5, each option being a predetermined time interval: 1 = 3 seconds 2 = 6 seconds 3 = 9 seconds 4 = 12 seconds 5 = 15 seconds hawait This is how long (in seconds) after the initial boot, before the LoadMaster becomes active. If the partner machine is running this value is ignored. This value can be changed to mitigate the time taken for some intelligent switches to detect that the LoadMaster has started and to bring up the link. haprefered By default, neither partner in a HA cluster has priority. When a machine restarts after a switchover that machine becomes a slave. Specifying a preferred host means that when this machine restarts it will always become the master and the partner will revert to slave mode. hamode Specify the HA mode. If only using a single LoadMaster, use Non-HA Mode. In HA mode, one LoadMaster must be specified as the first and another as second. HA will not work if both LoadMasters are specified the same. 0 = Turn off HA mode 1 = HA 1 mode 2 = HA 2 mode haif The network interface used when synchronising the configuration between the members of the HA cluster. havhid When using multiple HA LoadMasters on the same network, this value identifies each cluster so that there are no potential unwanted interactions. hastyle By default, the system uses a version of VRRP (carp) to check the status of the partner. The system can also support the legacy Heartbeat program. This option only takes effect when both machines are rebooted. 0 - legacy heartbeat 1 - carp hainitial Perform extra network checks at boot time. This may cause instability and should not be used. tcpfailover When using L4 services, enabling updates allows L4 connection maintenance across a HA switchover. This option is ignored for L7 services. This parameter is now deprecated and has been replaced with the HAL4update parameter. cookieupdate When using L7 services, enabling this option allows sharing of persistency information between HA partners. If a HA switchover occurs, the persistency information will then not be lost. Enabling this option can have a significant performance impact. This parameter is now deprecated and has been replaced with the HAL7Update parameter. hal4update When using L4 services, enabling updates allows L4 connection maintenance across a HA switchover. This option is ignored for L7 services. hal7update When using L7 services, enabling this option allows sharing of persistency information between HA partners. If a HA switchover occurs, the persistency information will then not be lost. Enabling this option can have a significant performance impact. vmac This option creates a shared MAC address for both units. When failover occurs, the LoadMaster handles the MAC address handover too. This allows the switches to keep the MAC address and not worry about ARP caches or stale records. Get-LmParameter Param The parameter to retrieve. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Get-LmParameter Param The parameter to retrieve. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String Param The parameter to retrieve. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Get-LmParameter -Param SSLRefreshInterval Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Data field...: @{SSLRefreshInterval=3700} Get-LmPreviousFirmwareVersion Retrieve the firmware version that was previously installed on the LoadMaster. Get LmPreviousFirmwareVersion This command returns the firmware version number for the last installed firmware version before the current one. Get-LmPreviousFirmwareVersion LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Get-LmPreviousFirmwareVersion LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Get-LmPreviousFirmwareVersion Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Data field...: @{PreviousVersion=7.2.39.0.14938.DEV.20170411-1306 } Get-LmVpnConnection Retrieves a list of all existing Virtual Private Network (VPN) connection details, or details for a specific VPN connection. Get LmVpnConnection To retrieve details for a specific VPN connection, use the Name parameter to specify the name of the relevant VPN connection. To retrieve details for all VPN connections, do not use the Name parameter. Get-LmVpnConnection Name Specify the name of a specific VPN connection to display the details for. To display details for all VPN connections - do not use this parameter. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Get-LmVpnConnection Name Specify the name of a specific VPN connection to display the details for. To display details for all VPN connections - do not use this parameter. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String Name Specify the name of a specific VPN connection to display the details for. To display details for all VPN connections - do not use this parameter. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Get-LmVpnConnection Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Data field...: @{VpnConfiguration=} Param........: @{name=ExampleVPN; status=Down; localIP=10.35.47.15; localSubnets=10.35.47.15/32; remoteIP=; remoteSubnets=; localID=10.35.47.15; remoteI D=; key=; pfs=disabled} name : ExampleVPN status : Down localIP : 10.35.47.15 localSubnets : 10.35.47.15/32 remoteIP : remoteSubnets : localID : 10.35.47.15 remoteID : key : pfs : disabled Get-LmVpnIkeDaemonStatus View the status of the Internet Key Exchange (IKE) daemon. Get LmVpnIkeDaemonStatus Run this command to check the status of the IKE daemon. Get-LmVpnIkeDaemonStatus LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Get-LmVpnIkeDaemonStatus LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Get-LmVpnIkeDaemonStatus Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Data field...: @{IkeDaemonStatus=Down} Get-LmWuiSetting Retrieve the LoadMaster Web User Interface (WUI) settings. Get LmWuiSetting This command returns the WUI settings, such as the Message of the Day and the Statistics Display Size. Get-LmWuiSetting LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Get-LmWuiSetting LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. String InformationAction ActionPreference InformationVariable String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. String String -------------------------- Example -------------------------- PS C:\> Get-LmWuiSetting Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Data field...: @{Parameters=} Param........: @{motd=Example Message of the Day; hoverhelp=no} Get-LogEmailConfiguration Allows you to view the values of the email logging options. Get LogEmailConfiguration Allows you to view the values of the email logging options. Get-LogEmailConfiguration LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Get-LogEmailConfiguration LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Get-LogEmailConfiguration Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed; Data=} Return Code..: 200 Response.....: Command successfully executed Data field...: @{EmailConfiguration=} Param........: @{EmailEnable=yes; EmailServer=10.154.22.132; EmailPort=80; EmailUser=test; EmailPassword=********; EmailDomain=ExampleDomain; EmailSSLMo de=1; EmailEmergency=; EmailCritical=; EmailError=; EmailWarn=; EmailNotice=; EmailInfo=} EmailEnable : yes EmailServer : 10.154.22.132 EmailPort : 80 EmailUser : test EmailPassword : ******** EmailDomain : ExampleDomain EmailSSLMode : 1 EmailEmergency : EmailCritical : EmailError : EmailWarn : EmailNotice : EmailInfo : Get-LogSplitInterval WARNING: This function is deprecated. Use the following command instead: Get-AdcL7LogInsightSplitConfiguration Get LogSplitInterval WARNING: This function is deprecated. Use the following command instead: Get-AdcL7LogInsightSplitConfiguration Get-LogSplitInterval LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String Get-LogSplitInterval LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String Get-LogStatistics Returns statistics and some settings for each of the services. Get LogStatistics Returns statistics and some settings for each of the services. Get-LogStatistics VirtualService Enable this option to only retrieve statistics for Virtual Services. SwitchParameter RealServer Enable this option to only retrieve statistics for Real Servers on the LoadMaster. SwitchParameter Totals Enable this to get all statistics from the LoadMaster. SwitchParameter LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Get-LogStatistics VirtualService Enable this option to only retrieve statistics for Virtual Services. SwitchParameter RealServer Enable this option to only retrieve statistics for Real Servers on the LoadMaster. SwitchParameter Totals Enable this to get all statistics from the LoadMaster. SwitchParameter LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String VirtualService Enable this option to only retrieve statistics for Virtual Services. SwitchParameter SwitchParameter RealServer Enable this option to only retrieve statistics for Real Servers on the LoadMaster. SwitchParameter SwitchParameter Totals Enable this to get all statistics from the LoadMaster. SwitchParameter SwitchParameter LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String If you run the Get-Statistics command on the admin node when using LoadMaster clustering – the output will show the combined totals of all machines. -------------------------- Example -------------------------- PS C:\> Get-LogStatistics Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Data field...: @{Vs=System.Object[]; VStotals=; CPU=; Network=; Memory=; TPS=; ChangeTime=1492771843} Vs : {@{VSAddress=10.154.11.181; VSPort=69; VSProt=udp; Index=1; Status=down; ErrorCode=0; Enable=1; TotalConns=0; TotalPkts=0; TotalBytes=0; TotalBits=0; ActiveConns=0; BytesRead=0; BytesWritten=0; ConnsPerSec=0; WafEnable=0}, @{VSAddress=10.154.11.181; VSPort=8081; VSProt=tcp; Index=3; Status=down; ErrorCode=0; Enable=1; TotalConns=0; TotalPkts=0; TotalBytes=0; TotalBits=0; ActiveConns=0; BytesRead=0; BytesWritten=0; ConnsPerSec=0; WafEnable=0}, @{VSAddress=10.154.11.182; VSPort=69; VSProt=tcp; Index=2; Status=down; ErrorCode=0; Enable=1; TotalConns=0; TotalPkts=0; TotalBytes=0; TotalBits=0; ActiveConns=0; BytesRead=0; BytesWritten=0; ConnsPerSec=0; WafEnable=0}, @{VSAddress=10.154.11.182; VSPort=8081; VSProt=tcp; Index=4; Status=down; ErrorCode=0; Enable=1; TotalConns=0; TotalPkts=0; TotalBytes=0; TotalBits=0; ActiveConns=0; BytesRead=0; BytesWritten=0; ConnsPerSec=0; WafEnable=0}} VStotals : @{ConnsPerSec=0; TotalConns=0; BitsPerSec=0; TotalBits=0; BytesPerSec=0; TotalBytes=0; PktsPerSec=0; TotalPackets=0} CPU : @{total=; cpu0=; cpu1=} Network : @{bnd0=; eth1=; eth1.1=; eth1.vxlan1=} Memory : @{memused=332188; percentmemused=16; memfree=1724424; percentmemfree=84} TPS : @{Total=0; SSL=0} ChangeTime : 1492771843 Get-LogSyslogConfiguration Allows you to view which hosts the various Syslog messages get sent to. Get LogSyslogConfiguration Allows you to view which hosts the various Syslog messages get sent to. Get-LogSyslogConfiguration LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Get-LogSyslogConfiguration LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Get-LogSyslogConfiguration Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed; Data=} Return Code..: 200 Response.....: Command successfully executed Data field...: @{SyslogSettings=} Param........: @{SyslogEmergency=; SyslogCritical=; SyslogError=; SyslogWarn=; SyslogNotice=; SyslogInfo=10.154.153.94; SyslogPort=60} SyslogEmergency : SyslogCritical : SyslogError : SyslogWarn : SyslogNotice : SyslogInfo : 10.154.153.94 SyslogPort : 60 Get-NetworkConfiguration Allows you to view the values of some networking options. Get NetworkConfiguration Allows you to view the values of some networking options. Get-NetworkConfiguration LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Get-NetworkConfiguration LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String This is a legacy command and does not return all of the available parameters. Please refer to the Get-Help of the Get-Parameter command to view a full list of parameters that can be returned. -------------------------- Example -------------------------- PS C:\> Get-NetworkConfiguration Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Data field...: @{NetworkConfiguration=} Param........: @{snat=yes; allowupload=no; conntimeout=660; keepalive=yes; multigw=no; nonlocalrs=no; onlydefaultroutes=no; resetclose=no; subnetorigin= yes; subnetoriginating=yes; tcptimestamp=no; routefilter=no; dhkeysize=2048; http_proxy=} snat : yes allowupload : no conntimeout : 660 keepalive : yes multigw : no nonlocalrs : no onlydefaultroutes : no resetclose : no subnetorigin : yes subnetoriginating : yes tcptimestamp : no routefilter : no dhkeysize : 2048 http_proxy : Get-NetworkDNSConfiguration Allows you to retrieve the values of the DNS Configuration options. Get NetworkDNSConfiguration Allows you to retrieve the values of the DNS Configuration options. Get-NetworkDNSConfiguration LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Get-NetworkDNSConfiguration LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String This is a legacy command and does not return all of the available parameters. Please refer to the Get-Help of the Get-Parameter command to view a full list of parameters that can be returned. -------------------------- Example -------------------------- PS C:\> Get-NetworkDNSConfiguration Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Data field...: @{NetworkDNSConfiguration=} Param........: @{Hostname=lb100; NamServer=10.154.75.25; SearchList= KEMP.LAB.INTRA} Hostname : lb100 NamServer : 10.154.75.25 SearchList : KEMP.LAB.INTRA Get-NetworkInterface Retreive details about all interfaces or a specific interface. Get NetworkInterface Specify the InterfaceID to retreive details for a particular interface. Otherwise, all interface details are displayed. Get-NetworkInterface InterfaceID The Interface ID to get settings for. If this parameter is omitted, it will default to eth0. To view the interface ID for each of the interfaces, run the Get-Statistics command. The interface ID is the first number displayed in each interface row. Int16 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Get-NetworkInterface InterfaceID The Interface ID to get settings for. If this parameter is omitted, it will default to eth0. To view the interface ID for each of the interfaces, run the Get-Statistics command. The interface ID is the first number displayed in each interface row. Int16 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String InterfaceID The Interface ID to get settings for. If this parameter is omitted, it will default to eth0. To view the interface ID for each of the interfaces, run the Get-Statistics command. The interface ID is the first number displayed in each interface row. Int16 Int16 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Get-NetworkInterface Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Id : 0 IPAddress : 10.154.11.180/16 Mtu : 1500 InterfaceType : Port GeoTrafficEnable : yes DefaultInterface : yes Id : 1 IPAddress : 10.154.11.180/16 Mtu : 1500 InterfaceType : Port GeoTrafficEnable : no DefaultInterface : no Get-NetworkOptions WARNING: This function is deprecated. Use the following command instead: Get-NetworkConfiguration Get NetworkOptions WARNING: This function is deprecated. Use the following command instead: Get-NetworkConfiguration Get-NetworkOptions LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String Get-NetworkOptions LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String Get-NetworkRoute Allows you to view the details of all Additional Routes. Get NetworkRoute Allows you to view the details of all Additional Routes. Get-NetworkRoute LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Get-NetworkRoute LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Get-NetworkRoute Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Route : @{Destination=10.154.11.24/32; Gateway=10.154.2.32} Get-NetworkSNMPConfiguration Allows you to view the values of the various SNMP options. Get NetworkSNMPConfiguration Allows you to view the values of the various SNMP options. Get-NetworkSNMPConfiguration LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Get-NetworkSNMPConfiguration LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Get-NetworkSNMPConfiguration Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed; Data=} Return Code..: 200 Response.....: Command successfully executed SNMPEnable : yes SNMPv3enable : no SNMPClient : SNMPCommunity : SNMPContact : SNMPLocation : SNMPTrapEnable : no Get-PacketFilterOptionACL Retrieves the value of the Packet Routing Filter option. Get PacketFilterOptionACL Retrieves the value of the Packet Routing Filter option. This can also be used to determine whether packet filtering is enabled. Get-PacketFilterOptionACL LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Get-PacketFilterOptionACL LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Get-PacketFilterOptionACL Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Data field...: @{PacketFilterConfiguration=} Param........: @{aclstatus=enable; aclmethod=reply; aclblockall=free} Get-Parameter WARNING: This function is deprecated. Use the following command instead: Get-LmParameter Get Parameter WARNING: This function is deprecated. Use the following command instead: Get-LmParameter Get-Parameter Param String LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String Get-Parameter Param String LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String Param String String LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String Get-RealServer WARNING: This function is deprecated. Use the following command instead: Get-AdcRealServer Get RealServer WARNING: This function is deprecated. Use the following command instead: Get-AdcRealServer Get-RealServer VirtualService String VSPort Int32 VSProtocol String VSIndex Int32 RealServer String RSPort Int32 RSIndex Int32 LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String Get-RealServer VirtualService String VSPort Int32 VSProtocol String VSIndex Int32 RealServer String RSPort Int32 RSIndex Int32 LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String VirtualService String String VSPort Int32 Int32 VSProtocol String String VSIndex Int32 Int32 RealServer String String RSPort Int32 Int32 RSIndex Int32 Int32 LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String Get-Route WARNING: This function is deprecated. Use the following command instead: Get-NetworkRoute Get Route WARNING: This function is deprecated. Use the following command instead: Get-NetworkRoute Get-Route LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String Get-Route LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String Get-Rule WARNING: This function is deprecated. Use the following command instead: Get-AdcContentRule Get Rule WARNING: This function is deprecated. Use the following command instead: Get-AdcContentRule Get-Rule RuleName String RuleType String All SwitchParameter LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String Get-Rule RuleName String RuleType String All SwitchParameter LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String RuleName String String RuleType String String All SwitchParameter SwitchParameter LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String Get-SAMLDomain Retrieve details about the specified SAML SSO domain. Get SAMLDomain Retrieve the parameter values for a SAML SSO domain. Get-SAMLDomain Domain The name of the SAML SSO domain to retrieve the details for. If the Domain is not specified, the command returns all the available SAML domains. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Get-SAMLDomain Domain The name of the SAML SSO domain to retrieve the details for. If the Domain is not specified, the command returns all the available SAML domains. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String Domain The name of the SAML SSO domain to retrieve the details for. If the Domain is not specified, the command returns all the available SAML domains. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Get-SAMLDomain Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Data field...: @{Domain=System.Object[]} Param........: Id : 9 Name : EXAMPLE2.COM server : 10.154.45.22 auth_type : SAML idp_entity_id : idp_sso_url : idp_logoff_url : idp_cert : sp_entity_id : idp-3.example.com sp_cert : UseSelfSigned sess_tout_type : idle time sess_tout_idle_pub : 900 sess_tout_duration_pub : 1800 GetSDNController WARNING: This function is deprecated. Use the following command instead: Get-SdnController WARNING: This function is deprecated. Use the following command instead: Get-SdnController GetSDNController LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String GetSDNController LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String Get-SdnController WARNING: This function is deprecated. Use the following command instead: Get-SdnController Get SdnController WARNING: This function is deprecated. Use the following command instead: Get-SdnController Get-SdnController LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Get-SdnController LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Get-SdnController Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=Data} Return Code..: 200 Response.....: Command successfully executed. Param........: cluster cluster id controller -- ---------- 1 controller 3 controller Get-SecAdminAccess Retrieve the admin access settings. Get SecAdminAccess This command returns the admin access settings (WuiDefaultGateway, WuiNetworkInterfaceId, WuiPort). Get-SecAdminAccess LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Get-SecAdminAccess LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Get-SecAdminAccess Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Data field...: @{SecAdminAccessConfiguration=} Param........: @{WuiDefaultGateway=; WuiNetworkInterfaceId=0; WuiPort=443} Get-SecAdminWuiConfiguration Retrieve the admin Web User Interface (WUI) access settings. Get SecAdminWuiConfiguration Displays these settings, including the supported TLS protocols and WUI cipher set. Get-SecAdminWuiConfiguration LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Get-SecAdminWuiConfiguration LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Get-SecAdminWuiConfiguration Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Data field...: @{SecAdminWuiConfiguration=} Param........: @{WUITLSProtocols=0; WUICipherset=; sessioncontrol=yes; sessionbasicauth=no; sessionmaxfailattempts=0; sessionidletime=0; sessionconcurre nt=0; wuipreauth=} Get-SecRemoteAccess Allows you to view Remote Access options. Get SecRemoteAccess Allows you to view Remote Access options. Get-SecRemoteAccess LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Get-SecRemoteAccess LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String This is a legacy command and does not return all of the available parameters. Please refer to the Get-Help of the Get-Parameter command to view a full list of parameters that can be returned. -------------------------- Example -------------------------- PS C:\> Get-SecRemoteAccess Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Param........: @{sshaccess=yes; sshiface=all; sshport=22; wuiaccess=yes; enableapi=yes; geoclients=; geopartners=10.154.11.190; geosshport=22; geosshifa ce=0; MultiHomedWui=no; SSHPreAuthBanner=; AllowUpdateChecks=yes} Get-SecRemoteAccessLoginMethod Retrieve the Admin Login Method. Get SecRemoteAccessLoginMethod This command returns the Admin Login Method for the WUI, for example, "Password or Client certificate" or "Password Only Access (default)". Get-SecRemoteAccessLoginMethod LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Get-SecRemoteAccessLoginMethod LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Get-SecRemoteAccessLoginMethod Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Data field...: @{LoginMethod=PasswordOrClientCertificate} Param........: PasswordOrClientCertificate PasswordOrClientCertificate Get-SecUser Displays permissions for a user, or users. Get SecUser Specifying a username for the User parameter displays details for that partiular user. Omitting the User parameter will return details for all users. Get-SecUser User Username of the relevant user. If this parameter is omitted, permissions for all users will be returned. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Get-SecUser User Username of the relevant user. If this parameter is omitted, permissions for all users will be returned. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String User Username of the relevant user. If this parameter is omitted, permissions for all users will be returned. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Get-SecUser Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Name Perms ---- ----- Example K360Central_10.154.172.215_158 root K360Central_10.154.153.94_14 root example2 Get-SecWuiAuthentication View the values of WUI Authentication and Authorization options. Get SecWuiAuthentication Returns details such as the RADIUS configuration. Get-SecWuiAuthentication LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Get-SecWuiAuthentication LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Get-SecWuiAuthentication Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Data field...: @{SecWuiAuthenticationConfiguration=} Param........: @{radiusserver=; radiusport=0; radiussecret=********; radiusrevalidateinterval=60; radiusbackupserver=; radiusbackupport=0; radiusbackups ecret=********; wuildapep=; sessionlocalauth=no; sessionauthmode=0} Get-ServiceHealth WARNING: This function is deprecated. Use the following command instead: Get-AdcServiceHealth Get ServiceHealth WARNING: This function is deprecated. Use the following command instead: Get-AdcServiceHealth Get-ServiceHealth LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String Get-ServiceHealth LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String Get-SNMPOption WARNING: This function is deprecated. Use the following command instead: Get-NetworkSNMPConfiguration Get SNMPOption WARNING: This function is deprecated. Use the following command instead: Get-NetworkSNMPConfiguration Get-SNMPOption LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String Get-SNMPOption LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String Get-SSODomain Returns a list of any SSO domains that exist and their settings. Get SSODomain Returns a list of any SSO domains that exist and their settings. Get-SSODomain Domain To retrieve details about a particular domain, specify the domain name using this parameter. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Get-SSODomain Domain To retrieve details about a particular domain, specify the domain name using this parameter. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String Domain To retrieve details about a particular domain, specify the domain name using this parameter. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Get-SSODomain Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Param........: @{Id=9; Name=EXAMPLE2.COM; testuser=; ldap_version=3; server_side=0; auth_type=RSA-SECURID; logon_fmt=Principalname; logon_fmt2=Principal name; logon_transcode=1; logon_domain=; idp_entity_id=; idp_sso_url=; idp_logoff_url=; idp_cert=; sp_entity_id=; sp_cert=UseSelfSigned; kerberos_domain= ; kerberos_kdc=; kcd_username=; max_failed_auths=0; reset_fail_tout=60; unblock_tout=1800; sess_tout_type=idle time; sess_tout_idle_pub=900; sess_tout_d uration_pub=1800; sess_tout_idle_priv=900; sess_tout_duration_priv=28800; cert_check_asi=0; cert_check_cn=0} Id : 9 Name : EXAMPLE2.COM testuser : ldap_version : 3 server_side : 0 auth_type : RSA-SECURID logon_fmt : Principalname logon_fmt2 : Principalname logon_transcode : 1 logon_domain : idp_entity_id : idp_sso_url : idp_logoff_url : idp_cert : sp_entity_id : sp_cert : UseSelfSigned kerberos_domain : kerberos_kdc : kcd_username : max_failed_auths : 0 reset_fail_tout : 60 unblock_tout : 1800 sess_tout_type : idle time sess_tout_idle_pub : 900 sess_tout_duration_pub : 1800 sess_tout_idle_priv : 900 sess_tout_duration_priv : 28800 cert_check_asi : 0 cert_check_cn : 0 Get-SSODomainLockedUser Displays a list of users who are currently blocked from accessing the SSO domain. Get SSODomainLockedUser Displays a list of users who are currently blocked from accessing the SSO domain. Get-SSODomainLockedUser Domain The name of the SSO domain. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Get-SSODomainLockedUser Domain The name of the SSO domain. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String Domain The name of the SSO domain. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Get-SSODomainLockedUser -Domain example2.com Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Data field...: @{LockedUsers=} Param........: @{domainid=1; user=ruth@qasp.com; locktime=Mon Apr 24 13:38:14 2017} domainid : 1 user : ruth@qasp.com locktime : Mon Apr 24 13:38:14 2017 Get-SSODomainSession Retrieve details of an open SSO domain session, or sessions. Get SSODomainSession Retrieve details of an open SSO domain session, or sessions. Get-SSODomainSession Domain Specify the name of the SSO domain to retrieve the details for. String User To retrieve a list of all open sessions for the specified SSO domain, leave this parameter blank. To narrow down the list to only retrieve sessions for a particular user, specify the username here. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Get-SSODomainSession Domain Specify the name of the SSO domain to retrieve the details for. String User To retrieve a list of all open sessions for the specified SSO domain, leave this parameter blank. To narrow down the list to only retrieve sessions for a particular user, specify the username here. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String Domain Specify the name of the SSO domain to retrieve the details for. String String User To retrieve a list of all open sessions for the specified SSO domain, leave this parameter blank. To narrow down the list to only retrieve sessions for a particular user, specify the username here. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Get-SSODomainSession -Domain qasp.com Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Data field...: @{SSOSession=} Param........: @{NumberOfSessions=1; Session=} NumberOfSessions : 1 Session : @{User=ruth@qasp.com; Client=10.0.70.230:40696; Destination=172.20.0.125; Created=2017-04-24 13:16:03; Expires=2017-04-24 13:46:03; Cookie=-} Get-Statistics WARNING: This function is deprecated. Use the following command instead: Get-LogStatistics Get Statistics WARNING: This function is deprecated. Use the following command instead: Get-LogStatistics Get-Statistics VirtualService SwitchParameter RealServer SwitchParameter Totals SwitchParameter LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String Get-Statistics VirtualService SwitchParameter RealServer SwitchParameter Totals SwitchParameter LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String VirtualService SwitchParameter SwitchParameter RealServer SwitchParameter SwitchParameter Totals SwitchParameter SwitchParameter LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String Get-SyslogOption WARNING: This function is deprecated. Use the following command instead: Get-LogSyslogConfiguration Get SyslogOption WARNING: This function is deprecated. Use the following command instead: Get-LogSyslogConfiguration Get-SyslogOption LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String Get-SyslogOption LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String Get-Template Retrieve a list of installed templates. Get Template This command will return a list of templates and related details. Get-Template LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Get-Template LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Get-Template Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Data field...: @{name=TFTP; comment=Handles TFTP over port 69 (Version 1.0); certified=yes} Get-TlsCertificate List the currently installed certificates and their fingerprints. Get TlsCertificate A list of certificates and fingerprints is displayed. Get-TlsCertificate CertName To retreive details for a particular certificate, specify the name using the CertName parameter. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Get-TlsCertificate CertName To retreive details for a particular certificate, specify the name using the CertName parameter. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String CertName To retreive details for a particular certificate, specify the name using the CertName parameter. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String Outform Specify the format - either PEM or DER. DER is Base64-encoded because it is a binary format. string string -------------------------- Example -------------------------- PS C:\> Get-TlsCertificate Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. name modulus ---- ------- Example C89E5A8F8B1FCD8F366D3DE3350B17BA44A18892DECE87B1149F26B849BA9581EFC281FBC9584F763430EF3EAC42E9F63866080766070A60C9314F10C0A07D3CE833928... 2 C89E5A8F8B1FCD8F366D3DE3350B17BA44A18892DECE87B1149F26B849BA9581EFC281FBC9584F763430EF3EAC42E9F63866080766070A60C9314F10C0A07D3CE833928... ExampleCert2 C89E5A8F8B1FCD8F366D3DE3350B17BA44A18892DECE87B1149F26B849BA9581EFC281FBC9584F763430EF3EAC42E9F63866080766070A60C9314F10C0A07D3CE833928... Get-TlsCipherSet Retrieve the list of ciphers in a cipher set. Get TlsCipherSet Retrieves the list of ciphers which are in a specified system-defined or custom cipher set. Get-TlsCipherSet Name The name of the cipher set. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Get-TlsCipherSet Name The name of the cipher set. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String Name The name of the cipher set. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Get-TlsCipherSet -Name Default Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. ECDHE-RSA-AES256-SHA384 ECDHE-ECDSA-AES256-SHA384 DHE-RSA-AES256-SHA256 DHE-DSS-AES256-SHA256 DH-RSA-AES256-SHA256 DH-DSS-AES256-SHA256 ECDH-RSA-AES256-SHA384 ECDH-ECDSA-AES256-SHA384 AES256-SHA256 AES256-SHA ECDHE-RSA-AES128-SHA256 ECDHE-ECDSA-AES128-SHA256 DHE-RSA-AES128-SHA256 DHE-DSS-AES128-SHA256 DH-RSA-AES128-SHA256 DH-DSS-AES128-SHA256 ECDH-RSA-AES128-SHA256 ECDH-ECDSA-AES128-SHA256 AES128-SHA256 AES128-SHA DES-CBC3-SHA Get-TlsHSM Displays the HSM configuration settings. Get TlsHSM Displays the HSM configuration settings. Get-TlsHSM LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Get-TlsHSM LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Get-TlsHSM Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Data field...: @{engine=cavhsm; addr=10.154.11.129; user=ExampleUser; enable=0} Get-TlsIntermediateCertificate Retrieve a list of intedmediate certificates currently installed on the LoadMaster. Get TlsIntermediateCertificate Retrieve a list of intedmediate certificates currently installed on the LoadMaster. Get-TlsIntermediateCertificate CertName To retrieve details for a particular intermediate certificate, specify the certificate name using the CertName parameter. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Get-TlsIntermediateCertificate CertName To retrieve details for a particular intermediate certificate, specify the certificate name using the CertName parameter. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String CertName To retrieve details for a particular intermediate certificate, specify the certificate name using the CertName parameter. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String Outform Specify the format - either PEM or DER. DER is Base64-encoded because it is a binary format. string string -------------------------- Example -------------------------- PS C:\> Get-TlsIntermediateCertificate Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. 1 C29073E67DD34ABC117326F05B3A6EBC7610ADF0C57D6731B705E56768C36CDA211FD4C21E1FE7D6E08986B2F72973C22E4AA1B5238FE2738C3F5A7202D67BE291C6CAEDA866... Exam... C89E5A8F8B1FCD8F366D3DE3350B17BA44A18892DECE87B1149F26B849BA9581EFC281FBC9584F763430EF3EAC42E9F63866080766070A60C9314F10C0A07D3CE833928F431D... Get-VirtualService WARNING: This function is deprecated. Use the following command instead: Get-AdcVirtualService Get VirtualService WARNING: This function is deprecated. Use the following command instead: Get-AdcVirtualService Get-VirtualService VirtualService String VSPort Int32 VSProtocol String VSIndex Int32 LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String Get-VirtualService VirtualService String VSPort Int32 VSProtocol String VSIndex Int32 LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String VirtualService String String VSPort Int32 Int32 VSProtocol String String VSIndex Int32 Int32 LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String Get-VSPacketFilterACL Displays the addresses on the black or white list for a Virtual Service. Get VSPacketFilterACL Lists the host and network IP addresses on the black or white access control list for a specific Virtual Service. Note that black and white lists are only enabled when packet filtering is enabled. Get-VSPacketFilterACL VirtualService Specifies the Virtual Service IP address. String VSPort Specifies the Virtual Service port number. Int32 VSProtocol Specifies the Virtual Service protocol: "tcp" or "udp". String Type Specify the type of list: - black: blocked addresses - white: allowed addresses Note: This is case sensitive – the type value should be in lowercase. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Get-VSPacketFilterACL VirtualService Specifies the Virtual Service IP address. String VSPort Specifies the Virtual Service port number. Int32 VSProtocol Specifies the Virtual Service protocol: "tcp" or "udp". String Type Specify the type of list: - black: blocked addresses - white: allowed addresses Note: This is case sensitive – the type value should be in lowercase. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String VirtualService Specifies the Virtual Service IP address. String String VSPort Specifies the Virtual Service port number. Int32 Int32 VSProtocol Specifies the Virtual Service protocol: "tcp" or "udp". String String Type Specify the type of list: - black: blocked addresses - white: allowed addresses Note: This is case sensitive – the type value should be in lowercase. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Get-VSPacketFilterACL -VSPort 80 -VSProtocol tcp -Type black -VirtualService 10.35.47.16 Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. 10.35.47.16 80 tcp @{addr=10.145.33.4/32; comment=} Get-WafAuditFiles Returns a list of the WAF audit file names. Get WafAuditFiles Returns a list of the WAF audit file names. Get-WafAuditFiles LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Get-WafAuditFiles LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Get-WafAuditFiles Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. File1 : wafaudit.1 GetWafChangeLog WARNING: This function is deprecated. Use the following command instead: Export-WafChangeLog WARNING: This function is deprecated. Use the following command instead: Export-WafChangeLog GetWafChangeLog Path String LoadBalancer String LBPort Int32 Credential Object Force SwitchParameter InformationAction ActionPreference InformationVariable String GetWafChangeLog Path String LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String Force SwitchParameter InformationAction ActionPreference InformationVariable String Path String String LoadBalancer String String LBPort Int32 Int32 Credential Object Object Force SwitchParameter SwitchParameter InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String Get-WafRules Displays details about all installed Web Application Firewall (WAF) rules (commercial and custom). Get WafRules Displays details about all installed Web Application Firewall (WAF) rules (commercial and custom). It also shows if the rules are active or not. Active rules are ones that have been assigned to one or more Virtual Services. Get-WafRules LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Get-WafRules LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Get-WafRules Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Inactive1 : Generic/ip_reputation Inactive2 : Generic/known_vulns Inactive3 : Generic/malware_detection Inactive4 : Generic/botnet_attacks Inactive5 : Generic/creditcard_known Inactive6 : Generic/creditcard_track_pan Inactive7 : ApplicationSpecific/cpanel_attacks Inactive8 : ApplicationSpecific/drupal_attacks Inactive9 : ApplicationSpecific/joomla_attacks Inactive10 : ApplicationSpecific/modx_attacks Inactive11 : ApplicationSpecific/netcat_attacks Inactive12 : ApplicationSpecific/oscommerce_attacks Inactive13 : ApplicationSpecific/phpbb_attacks Inactive14 : ApplicationSpecific/sharepoint_attacks Inactive15 : ApplicationSpecific/typo3_attacks Inactive16 : ApplicationSpecific/vbulletin_attacks Inactive17 : ApplicationSpecific/wordpress_attacks Inactive18 : ApplicationSpecific/owa_attacks Inactive19 : ApplicationSpecific/iis_attacks Inactive20 : ApplicationGeneric/lfi_attacks Inactive21 : ApplicationGeneric/rfi_attacks Inactive22 : ApplicationGeneric/sqli_attacks Inactive23 : ApplicationGeneric/xss_attacks Get-WafRulesAutoUpdateConfiguration Displays the values of the Web Application Firewall (WAF) auto-update configuration. Get WafRulesAutoUpdateConfiguration Displays the values of the WAF configuration relating to the automatic updating of commercial rules. Get-WafRulesAutoUpdateConfiguration LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Get-WafRulesAutoUpdateConfiguration LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Get-WafRulesAutoUpdateConfiguration Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. AutoUpdate : 0 AutoInstall : 1 InstallTimeHour : 4 LastUpdated : 2017-04-05 GetWafSettings WARNING: This function is deprecated. Use the following command instead: Get-WafRulesAutoUpdateConfiguration WARNING: This function is deprecated. Use the following command instead: Get-WafRulesAutoUpdateConfiguration GetWafSettings LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String GetWafSettings LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String Get-WUIAuth WARNING: This function is deprecated. Use the following command instead: Get-SecWuiAuthentication Get WUIAuth WARNING: This function is deprecated. Use the following command instead: Get-SecWuiAuthentication Get-WUIAuth LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String Get-WUIAuth LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String Get-WUISetting WARNING: This function is deprecated. Use the following command instead: Get-SecAdminWuiConfiguration Get WUISetting WARNING: This function is deprecated. Use the following command instead: Get-SecAdminWuiConfiguration Get-WUISetting LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String Get-WUISetting LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String HSMConfigure WARNING: This function is deprecated. Use the following command instead: Set-TlsHSM WARNING: This function is deprecated. Use the following command instead: Set-TlsHSM HSMConfigure Sethsm String Safeaddr String Clpass String Enable Boolean Cavhsmaddr String Cavhsmpasswd String Cavhsmuser String Cavhsmenable Boolean LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String HSMConfigure Sethsm String Safeaddr String Clpass String Enable Boolean Cavhsmaddr String Cavhsmpasswd String Cavhsmuser String Cavhsmenable Boolean LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String Sethsm String String Safeaddr String String Clpass String String Enable Boolean Boolean Cavhsmaddr String String Cavhsmpasswd String String Cavhsmuser String String Cavhsmenable Boolean Boolean LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String HSMGenerateClientCert WARNING: This function is deprecated. Use the following command instead: New-TlsHSMClientCert WARNING: This function is deprecated. Use the following command instead: New-TlsHSMClientCert HSMGenerateClientCert Path String Clcertname String LoadBalancer String LBPort Int32 Credential Object Force SwitchParameter InformationAction ActionPreference InformationVariable String HSMGenerateClientCert Path String Clcertname String LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String Force SwitchParameter InformationAction ActionPreference InformationVariable String Path String String Clcertname String String LoadBalancer String String LBPort Int32 Int32 Credential Object Object Force SwitchParameter SwitchParameter InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String HSMShow WARNING: This function is deprecated. Use the following command instead: Get-TlsHSM WARNING: This function is deprecated. Use the following command instead: Get-TlsHSM HSMShow LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String HSMShow LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String HSMUploadCACert WARNING: This function is deprecated. Use the following command instead: Import-TlsHSMCACert WARNING: This function is deprecated. Use the following command instead: Import-TlsHSMCACert HSMUploadCACert Path String LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String HSMUploadCACert Path String LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String Path String String LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String Import-GeoDNSSECKeySigningKey Import the GEO DNSSEC Key Signing Keys (KSKs). Import GeoDNSSECKeySigningKey This command uploads both KSK files at the same time. Import-GeoDNSSECKeySigningKey privateKeyFile The path to the private key file to upload. String publicKeyFile The path to the public key file to upload. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Import-GeoDNSSECKeySigningKey privateKeyFile The path to the private key file to upload. String publicKeyFile The path to the public key file to upload. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String privateKeyFile The path to the private key file to upload. String String publicKeyFile The path to the public key file to upload. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Import-GeoDNSSECKeySigningKey -privateKeyFile .\key.private -publicKeyFile .\public.key Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Import-TlsHSMCACert Upload the Certificate Authority (CA) certificate that has been downloaded from the Hardware Security Module (HSM). Import TlsHSMCACert Upload the CA certificate that has been downloaded from the HSM. Import-TlsHSMCACert Path The path to the certificate file followed by a backslash and the certificate file name followed by the file extension (.pem). String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Import-TlsHSMCACert Path The path to the certificate file followed by a backslash and the certificate file name followed by the file extension (.pem). String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String Path The path to the certificate file followed by a backslash and the certificate file name followed by the file extension (.pem). String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Import-TlsHSMCACert –Path c:\CertificateFileName.pem Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Initialize-LmConnectionParameters Specify the connection parameters to use for the session. Initialize LmConnectionParameters To run PowerShell API commands, you need to establish authentication with the LoadMaster. There are two ways to establish authentication: • Using credentials; a LoadMaster username (Credential) and password • Using certificate-based authentication Whichever option you use, you can either specify the parameters when running individual commands, or using the Initialize-LmConnectionParameters command. You can also globally set the KEMP LoadMaster IP address that you are directing the commands to by using the Initialize-LmConnectionParameters command, for example: Initialize-LmConnectionParameters -Address 10.11.0.60 -LBPort 443 -Credential bal You can either enter a username for the LoadMaster or provide a PSCredential object. When you enter a username, a prompt appears asking for the password. You can override the globally-provided LoadBalancer address and username on each individual command by using the LoadBalancer or Credential parameter within the command. Similarly, you can specify the details to use certificate-based authentication using the Initialize-LmConnectionParameters command. For further information on the various steps involved to configure certificate-based authentication, refer to the PowerShell Interface Description document. Initialize-LmConnectionParameters Address Specify the address of the LoadMaster to run commands on. Use this command to specify the LoadMaster address to be used for this session. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Use this command to specify the LoadMaster port to be used for the session. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Use this command to specify the username for the session. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Initialize-LmConnectionParameters Address Specify the address of the LoadMaster to run commands on. Use this command to specify the LoadMaster address to be used for this session. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Use this command to specify the LoadMaster port to be used for the session. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Use this command to specify the CertificateStoreLocation for the session. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Use this command to specify the SubjectCN for the session. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String Address Specify the address of the LoadMaster to run commands on. Use this command to specify the LoadMaster address to be used for this session. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Use this command to specify the LoadMaster port to be used for the session. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Use this command to specify the username for the session. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Use this command to specify the CertificateStoreLocation for the session. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Use this command to specify the SubjectCN for the session. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Initialize-LmConnectionParameters -Address 10.154.11.180 -Credential bal Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Initialize-LoadBalancer WARNING: This function is deprecated. Use the following command instead: Initialize-LmConnectionParameters Initialize LoadBalancer WARNING: This function is deprecated. Use the following command instead: Initialize-LmConnectionParameters Initialize-LoadBalancer Address String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String Initialize-LoadBalancer Address String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String Address String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String Install-GeoIPBlacklistDatabase Install any downloaded updates now. Install GeoIPBlacklistDatabase Run this command to install any updates to the GEO IP blacklist database which have been downloaded. Install-GeoIPBlacklistDatabase LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Install-GeoIPBlacklistDatabase LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Install-GeoIPBlacklistDatabase Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Install-LmAddon Allows you to upload an add-on pack. Install LmAddon Allows you to upload an add-on pack. Install-LmAddon Path The path to the add-on file followed by a backslash and then the filename, for example C:\Users\ExampleUser\Desktop\Akami.7.1-22b.20141204-1618 String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Install-LmAddon Path The path to the add-on file followed by a backslash and then the filename, for example C:\Users\ExampleUser\Desktop\Akami.7.1-22b.20141204-1618 String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String Path The path to the add-on file followed by a backslash and then the filename, for example C:\Users\ExampleUser\Desktop\Akami.7.1-22b.20141204-1618 String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Install-LmAddon -Path C:\Temp\SMART.7.2.39.0.15038.DEV.20170424-0907 Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Data field...: @{Package=Addon Package \'SMART\' Correctly installed - Please reboot to activate it.} Install-LmPatch Allows you to update the LoadMaster with a patch to the firmware. Install LmPatch Allows you to update the LoadMaster with a patch to the firmware. You will be asked to restart the LoadMaster for the command to complete. Install-LmPatch Path The local path to the LoadMaster patch file that should be uploaded. This parameter is required. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Install-LmPatch Path The local path to the LoadMaster patch file that should be uploaded. This parameter is required. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String Path The local path to the LoadMaster patch file that should be uploaded. This parameter is required. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Install-LmPatch -Path c:\SoftwareUpdate\7.0-10.20130507-1024-32bit Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Data field...: @{PatchData=Patch successfully installed. Please reboot the LM to apply the new software.} Install-Patch WARNING: This function is deprecated. Use the following command instead: Install-LmPatch Install Patch WARNING: This function is deprecated. Use the following command instead: Install-LmPatch Install-Patch Path String LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String Install-Patch Path String LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String Path String String LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String Install-SAMLIdpMetafile Upload an Identity Provider (IdP) metadata file. Install SAMLIdpMetafile This simplifies the configuration of the IdP attributes, including the IdP Entity ID, IdP SSO URL and IdP Logoff URL. The metadata file can be downloaded from the IdP. Install-SAMLIdpMetafile Domain The name of the SSO domain to upload the mdetadata file to. String Path The path to the metadata file to be uploaded, followed by the filename and extension, for example, C:\ExampleFolder\ExampleIdPMetaDataFile.xml. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Install-SAMLIdpMetafile Domain The name of the SSO domain to upload the mdetadata file to. String Path The path to the metadata file to be uploaded, followed by the filename and extension, for example, C:\ExampleFolder\ExampleIdPMetaDataFile.xml. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String Domain The name of the SSO domain to upload the mdetadata file to. String String Path The path to the metadata file to be uploaded, followed by the filename and extension, for example, C:\ExampleFolder\ExampleIdPMetaDataFile.xml. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Install-SAMLIdpMetafile -Domain example2.com -Path C:\Temp\federationmetadata.xml.zip Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Data field...: @{Domain=} Param........: @{Id=9; Name=EXAMPLE2.COM; server=10.154.45.22; auth_type=SAML; idp_entity_id=; idp_sso_url=; idp_logoff_url=; idp_cert=; sp_entity_id=; sp_cert=UseSelfSigned; sess_tout_type=idle time; sess_tout_idle_pub=900; sess_tout_duration_pub=1800} Id : 9 Name : EXAMPLE2.COM server : 10.154.45.22 auth_type : SAML idp_entity_id : idp_sso_url : idp_logoff_url : idp_cert : sp_entity_id : sp_cert : UseSelfSigned sess_tout_type : idle time sess_tout_idle_pub : 900 sess_tout_duration_pub : 1800 Install-SSORSAConfigurationFile Allows you to upload the RSA configuration file. Install SSORSAConfigurationFile If using RSA-SECURID as the authtype, a configuration file needs to be uploaded to the LoadMaster in order for the authentication to work. The Install-SSORSAConfigurationFile command can be used to upload these files. Install-SSORSAConfigurationFile Path The path to the RSA configuration file, followed by a backslash and then the filename.extension. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Install-SSORSAConfigurationFile Path The path to the RSA configuration file, followed by a backslash and then the filename.extension. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String Path The path to the RSA configuration file, followed by a backslash and then the filename.extension. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Install-SSORSAConfigurationFile -Path C:\examplefolder.AM_Config.zip Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed. Authentication Manager Config successfully loaded.; Data=} Return Code..: 200 Response.....: Command successfully executed. Authentication Manager Config successfully loaded. Install-SSORSANodeSecretAndPassword Allows you to upload the node secret file. Install SSORSANodeSecretAndPassword If using RSA-SECURID as the authtype, a node secret file needs to be uploaded to the LoadMaster in order for the authentication to work. To upload the node secret file, run the Install-SSORSANodeSecretAndPassword command. Install-SSORSANodeSecretAndPassword Password The password to decrypt the node secret. String Path The path to the node secret file, followed by a backslash and then the filename.extension. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Install-SSORSANodeSecretAndPassword Password The password to decrypt the node secret. String Path The path to the node secret file, followed by a backslash and then the filename.extension. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String Password The password to decrypt the node secret. String String Path The path to the node secret file, followed by a backslash and then the filename.extension. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Install-SSORSANodeSecretAndPassword -Password examplepassword -Path C:\examplefolder\LM_NodeSecret.zip Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed. Node Secret successfully loaded.; Data=} Return Code..: 200 Response.....: Command successfully executed. Node Secret successfully loaded. Install-Template Allows you to upload a template to the LoadMaster. Install Template Allows you to upload a template to the LoadMaster. Install-Template Path The path to the template location followed by a backslash and the filename of the template.tmpl. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Install-Template Path The path to the template location followed by a backslash and the filename of the template.tmpl. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String Path The path to the template location followed by a backslash and the filename of the template.tmpl. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Install-Template –Path “C:\ Exchange2013Additional v1.6.4.tmpl” Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. TemplateData ------------ Installed 1 new KEMP certified templates. Install-WafRulesDatabase Manually install the latest commercial Web Application Firewall (WAF) rules. Install WafRulesDatabase Manually install the (previously downloaded) latest commercial WAF rules. Install-WafRulesDatabase LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Install-WafRulesDatabase LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Install-WafRulesDatabase Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. IsGEOEnabled WARNING: This function is deprecated. Use the following command instead: Test-LmGeoEnabled WARNING: This function is deprecated. Use the following command instead: Test-LmGeoEnabled IsGEOEnabled LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String IsGEOEnabled LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String Join-Cluster Initiates a node joining a cluster. Join Cluster This makes the node LoadMaster available to be added. To finish adding the node, please run the New-ClusterNode command on the shared IP address immediately after running the Join-Cluster command in a different console window. Join-Cluster LoadBalancer Specify the shared address of the cluster to run the command on. Note: The address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Join-Cluster LoadBalancer Specify the shared address of the cluster to run the command on. Note: The address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String LoadBalancer Specify the shared address of the cluster to run the command on. Note: The address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Join-Cluster Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. ListAddons WARNING: This function is deprecated. Use the following command instead: Get-LmAddOn WARNING: This function is deprecated. Use the following command instead: Get-LmAddOn ListAddons LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String ListAddons LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String ListCert WARNING: This function is deprecated. Use the following command instead: Get-TlsCertificate WARNING: This function is deprecated. Use the following command instead: Get-TlsCertificate ListCert CertName String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String ListCert CertName String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String CertName String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String -------------------------- Example -------------------------- PS C:\> ListCert Example Command: cert ---- ExampleCertificate ListCustomLocation WARNING: This function is deprecated. Use the following command instead: Get-GeoCustomLocation WARNING: This function is deprecated. Use the following command instead: Get-GeoCustomLocation ListCustomLocation LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String ListCustomLocation LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String ListFQDNs Displays each of the FQDNs and their settings. Displays each of the FQDNs and their settings. ListFQDNs FQDN String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String ListFQDNs FQDN String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String FQDN String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String -------------------------- Example -------------------------- PS C:\> ListFQDNs Example Output: Mapping : 0 IsolatedIPs : Y SiteRecoveryMode : auto FailTime : 300 Failover : 0 SelectionCriteria : rr FullyQualifiedDomainName : www.example3.com. Mapping : 0 IsolatedIPs : Y SiteRecoveryMode : auto FailTime : 0 Failover : 0 SelectionCriteria : rr FullyQualifiedDomainName : 10.154.60.65. Mapping : 0 IsolatedIPs : Y SiteRecoveryMode : auto FailTime : 0 Failover : 0 SelectionCriteria : rr FullyQualifiedDomainName : example4.com. ListIfconfig WARNING: This function is deprecated. Use the following command instead: Get-LmNetworkInterface WARNING: This function is deprecated. Use the following command instead: Get-LmNetworkInterface ListIfconfig LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String ListIfconfig LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> ListIfconfig Example Output: Network ------- 0eth010002718138020260710800up1462801058,1eth11000171006002076800up1462801058,2bnd21000206736002035771400up1462801058,3bnd31000206748402135745000up1462801058 ListIPs WARNING: This function is deprecated. Use the following command instead: Get-GeoIpRange WARNING: This function is deprecated. Use the following command instead: Get-GeoIpRange ListIPs IP String LoadBalancer The IP address of the KEMP LoadMaster that you are directing the command to. This can be set globally by using the Initialize-LoadBalancer command, but can be overridden on each individual command by using this parameter. String LBPort Int32 Credential Specifies a user account that has permission to administer the load balancer. You can either enter a username for the load balancer or provide a PSCredential object, such as an object that is returned by the Get-Credential cmdlet. When you type a username, you are prompted for a password. Object InformationAction ActionPreference InformationVariable String ListIPs IP String LoadBalancer The IP address of the KEMP LoadMaster that you are directing the command to. This can be set globally by using the Initialize-LoadBalancer command, but can be overridden on each individual command by using this parameter. String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String IP String String LoadBalancer The IP address of the KEMP LoadMaster that you are directing the command to. This can be set globally by using the Initialize-LoadBalancer command, but can be overridden on each individual command by using this parameter. String String LBPort Int32 Int32 Credential Specifies a user account that has permission to administer the load balancer. You can either enter a username for the load balancer or provide a PSCredential object, such as an object that is returned by the Get-Credential cmdlet. When you type a username, you are prompted for a password. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String -------------------------- Example -------------------------- PS C:\> ListIPs Example Output: Longitude : 1234 Ip : 10.154.11.29 Used : Y IsCustom : Y Mask : 32 Index : 1 CustomLocation : ExampleLocation2 IPAddress : 10.154.11.29 Latitude : 1234 Ip : 10.154.11.30 Used : Y IsCustom : N Mask : 32 Index : 2 IPAddress : 10.154.11.30 country : IE,Ireland ListMiscParameters WARNING: This function is deprecated. Use the following command instead: Get-GeoMiscParameter WARNING: This function is deprecated. Use the following command instead: Get-GeoMiscParameter ListMiscParameters LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String ListMiscParameters LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String ListTemplates WARNING: This function is deprecated. Use the following command instead: Get-Template WARNING: This function is deprecated. Use the following command instead: Get-Template ListTemplates LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String ListTemplates LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String ListVpns WARNING: This function is deprecated. Use the following command instead: Get-LmVpnConnection WARNING: This function is deprecated. Use the following command instead: Get-LmVpnConnection ListVpns Name String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String ListVpns Name String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String Name String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String -------------------------- Example -------------------------- PS C:\> ListVpns Example Output: pfs : disabled localIP : 10.154.11.10 remoteSubnet : 10.154.11.30/32 remoteIP : 10.154.11.20 name : Example remoteID : 10.154.11.20 localID : 10.154.11.10 status : Down localSubnet : 10.154.11.10/32 key : ListWafAuditFiles WARNING: This function is deprecated. Use the following command instead: Get-WafAuditFiles WARNING: This function is deprecated. Use the following command instead: Get-WafAuditFiles ListWafAuditFiles LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String ListWafAuditFiles LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String ListWafRules WARNING: This function is deprecated. Use the following command instead: Get-WafRules WARNING: This function is deprecated. Use the following command instead: Get-WafRules ListWafRules LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String ListWafRules LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String LocationDataUpdate WARNING: This function is deprecated. Use the following command instead: Update-GeoDatabase WARNING: This function is deprecated. Use the following command instead: Update-GeoDatabase LocationDataUpdate Path String LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String LocationDataUpdate Path String LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String Path String String LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String ManInstallWafRules WARNING: This function is deprecated. Use the following command instead: Install-WafRulesDatabase WARNING: This function is deprecated. Use the following command instead: Install-WafRulesDatabase ManInstallWafRules LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String ManInstallWafRules LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String An error message will be displayed if any problems occur while installing the rules. -------------------------- Example -------------------------- PS C:\> ManInstallWafRules Example Output: ok ModifyCipherset WARNING: This function is deprecated. Use the following command instead: Set-TlsCipherSet WARNING: This function is deprecated. Use the following command instead: Set-TlsCipherSet ModifyCipherset Name String Value String LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String ModifyCipherset Name String Value String LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String Name String String Value String String LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String ModifyCluster WARNING: This function is deprecated. Use the following command instead: Set-GeoCluster WARNING: This function is deprecated. Use the following command instead: Set-GeoCluster ModifyCluster ClusterIp String ClusterName String Type String Checker String CheckerPort Int32 Enable String LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String ModifyCluster ClusterIp String ClusterName String Type String Checker String CheckerPort Int32 Enable String LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String ClusterIp String String ClusterName String String Type String String Checker String String CheckerPort Int32 Int32 Enable String String LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String ModifyFQDN WARNING: This function is deprecated. Use the following command instead: Set-GeoFQDN WARNING: This function is deprecated. Use the following command instead: Set-GeoFQDN ModifyFQDN FQDN String SelectionCriteria String SiteFailureDelay Int32 SiteRecoveryMode String PublicRequest String PrivateRequest String Failover String LocalSettings Boolean localttl Int32 localsticky Int32 UnanimousChecks Boolean LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String ModifyFQDN FQDN String SelectionCriteria String SiteFailureDelay Int32 SiteRecoveryMode String PublicRequest String PrivateRequest String Failover String LocalSettings Boolean localttl Int32 localsticky Int32 UnanimousChecks Boolean LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String FQDN String String SelectionCriteria String String SiteFailureDelay Int32 Int32 SiteRecoveryMode String String PublicRequest String String PrivateRequest String String Failover String String LocalSettings Boolean Boolean localttl Int32 Int32 localsticky Int32 Int32 UnanimousChecks Boolean Boolean LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String ModifyIPLocation WARNING: This function is deprecated. Use the following command instead: Set-GeoIPRangeCoordinates WARNING: This function is deprecated. Use the following command instead: Set-GeoIPRangeCoordinates ModifyIPLocation IP String Lat Int32 Long Int32 LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String ModifyIPLocation IP String Lat Int32 Long Int32 LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String IP String String Lat Int32 Int32 Long Int32 Int32 LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String ModifyMap WARNING: This function is deprecated. Use the following command instead: Set-GeoFQDNSiteAddress WARNING: This function is deprecated. Use the following command instead: Set-GeoFQDNSiteAddress ModifyMap FQDN String SiteAddress String Checker String Weight Int32 Enable String Cluster String Mapaddress String Mapport String LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String ModifyMap FQDN String SiteAddress String Checker String Weight Int32 Enable String Cluster String Mapaddress String Mapport String LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String FQDN String String SiteAddress String String Checker String String Weight Int32 Int32 Enable String String Cluster String String Mapaddress String String Mapport String String LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String ModifyMiscParameters WARNING: This function is deprecated. Use the following command instead: Set-GeoMiscParameter WARNING: This function is deprecated. Use the following command instead: Set-GeoMiscParameter ModifyMiscParameters SourceOfAuthority String NameSrv String SOAEmail String TTL String Persist String CheckInterval String ConnTimeout String RetryAttempts String Zone String LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String ModifyMiscParameters SourceOfAuthority String NameSrv String SOAEmail String TTL String Persist String CheckInterval String ConnTimeout String RetryAttempts String Zone String LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String SourceOfAuthority String String NameSrv String String SOAEmail String String TTL String String Persist String String CheckInterval String String ConnTimeout String String RetryAttempts String String Zone String String LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String ModifySDNController WARNING: This function is deprecated. Use the following command instead: Set-SdnController WARNING: This function is deprecated. Use the following command instead: Set-SdnController ModifySDNController Cid Int32 Clid Int32 IPV4 String Port Int32 Https Boolean User String Password String LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String ModifySDNController Cid Int32 Clid Int32 IPV4 String Port Int32 Https Boolean User String Password String LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String Cid Int32 Int32 Clid Int32 Int32 IPV4 String String Port Int32 Int32 Https Boolean Boolean User String String Password String String LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String New-AdcContentRule Allows you to add a new rule to the LoadMaster. New AdcContentRule Allows you to add a new Content Rule rule. New-AdcContentRule RuleName The desired name for the new content rule. String MatchType Specifies whether the rule matches on a regular expression (regex), prefix, or postfix. This parameter defaults to regex, but will also accept prefix or postfix. String IncHost Specifies whether to include the host in the URL. This is disabled by default. Boolean NoCase Specifies whether to ignore case/capitalization. This is disabled by default. Boolean Negate Specifies whether to invert the case of the match. This is disabled by default. Boolean IncQuery Specifies whether to include the query string in the match. This is disabled by default. Boolean Header Specifies the header that a match should be performed on. Set this to body to match on the body of a request. String Pattern Specifies the pattern to search for. String Replacement Specifies the replacement string for the pattern. You can enter a maximum of 255 characters in this parameter. String Type The type of content rule: 0 - Content Matching 1 - Add Header 2 - Delete Header 3 - Replace Header 4 - Modify URL 5 - Replace String in Response Body When creating a Rule - if the "type" is not specified, it will default to zero, that is, a Content Matching rule. The other parameters available for the New-AdcContentRule command depend on the "type" of content rule being added. Int32 MustFail If this rule is matched, then always fail to connect. 0 - Disabled (do not fail to connect) 1 - Enabled (fail to connect) Int32 OnlyOnFlag Only try to execute this rule if the specified flag is set by another rule (the OnlyOnFlag parameter is used in conjunction with the SetFlagOnMatch parameter). Using the OnlyOnFlag and SetFlagOnMatch parameters, it is possible to make rules dependent on each other, that is, only execute a particular rule if another rule has been successfully matched ('chaining' rules). For more detailed instructions on ‘chaining’ rules, please refer to the Content Rules, Feature Description document on the KEMP Documentation Page: https://kemptechnologies.com/loadmaster-documentation/ Valid values: 0-9 Int32 SetFlagOnMatch If the rule is successfully matched, set the specified flag. Using the OnlyOnFlag and SetFlagOnMatch parameters, it is possible to make rules dependent on each other, that is, only execute a particular rule if another rule has been successfully matched. For more detailed instructions on ‘chaining’ rules, please refer to the Content Rules, Feature Description document on the KEMP Documentation Page: https://kemptechnologies.com/loadmaster-documentation/. Valid values: 0-9 Int32 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String New-AdcContentRule RuleName The desired name for the new content rule. String MatchType Specifies whether the rule matches on a regular expression (regex), prefix, or postfix. This parameter defaults to regex, but will also accept prefix or postfix. String IncHost Specifies whether to include the host in the URL. This is disabled by default. Boolean NoCase Specifies whether to ignore case/capitalization. This is disabled by default. Boolean Negate Specifies whether to invert the case of the match. This is disabled by default. Boolean IncQuery Specifies whether to include the query string in the match. This is disabled by default. Boolean Header Specifies the header that a match should be performed on. Set this to body to match on the body of a request. String Pattern Specifies the pattern to search for. String Replacement Specifies the replacement string for the pattern. You can enter a maximum of 255 characters in this parameter. String Type The type of content rule: 0 - Content Matching 1 - Add Header 2 - Delete Header 3 - Replace Header 4 - Modify URL 5 - Replace String in Response Body When creating a Rule - if the "type" is not specified, it will default to zero, that is, a Content Matching rule. The other parameters available for the New-AdcContentRule command depend on the "type" of content rule being added. Int32 MustFail If this rule is matched, then always fail to connect. 0 - Disabled (do not fail to connect) 1 - Enabled (fail to connect) Int32 OnlyOnFlag Only try to execute this rule if the specified flag is set by another rule (the OnlyOnFlag parameter is used in conjunction with the SetFlagOnMatch parameter). Using the OnlyOnFlag and SetFlagOnMatch parameters, it is possible to make rules dependent on each other, that is, only execute a particular rule if another rule has been successfully matched ('chaining' rules). For more detailed instructions on ‘chaining’ rules, please refer to the Content Rules, Feature Description document on the KEMP Documentation Page: https://kemptechnologies.com/loadmaster-documentation/ Valid values: 0-9 Int32 SetFlagOnMatch If the rule is successfully matched, set the specified flag. Using the OnlyOnFlag and SetFlagOnMatch parameters, it is possible to make rules dependent on each other, that is, only execute a particular rule if another rule has been successfully matched. For more detailed instructions on ‘chaining’ rules, please refer to the Content Rules, Feature Description document on the KEMP Documentation Page: https://kemptechnologies.com/loadmaster-documentation/. Valid values: 0-9 Int32 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String RuleName The desired name for the new content rule. String String MatchType Specifies whether the rule matches on a regular expression (regex), prefix, or postfix. This parameter defaults to regex, but will also accept prefix or postfix. String String IncHost Specifies whether to include the host in the URL. This is disabled by default. Boolean Boolean NoCase Specifies whether to ignore case/capitalization. This is disabled by default. Boolean Boolean Negate Specifies whether to invert the case of the match. This is disabled by default. Boolean Boolean IncQuery Specifies whether to include the query string in the match. This is disabled by default. Boolean Boolean Header Specifies the header that a match should be performed on. Set this to body to match on the body of a request. String String Pattern Specifies the pattern to search for. String String Replacement Specifies the replacement string for the pattern. You can enter a maximum of 255 characters in this parameter. String String Type The type of content rule: 0 - Content Matching 1 - Add Header 2 - Delete Header 3 - Replace Header 4 - Modify URL 5 - Replace String in Response Body When creating a Rule - if the "type" is not specified, it will default to zero, that is, a Content Matching rule. The other parameters available for the New-AdcContentRule command depend on the "type" of content rule being added. Int32 Int32 MustFail If this rule is matched, then always fail to connect. 0 - Disabled (do not fail to connect) 1 - Enabled (fail to connect) Int32 Int32 OnlyOnFlag Only try to execute this rule if the specified flag is set by another rule (the OnlyOnFlag parameter is used in conjunction with the SetFlagOnMatch parameter). Using the OnlyOnFlag and SetFlagOnMatch parameters, it is possible to make rules dependent on each other, that is, only execute a particular rule if another rule has been successfully matched ('chaining' rules). For more detailed instructions on ‘chaining’ rules, please refer to the Content Rules, Feature Description document on the KEMP Documentation Page: https://kemptechnologies.com/loadmaster-documentation/ Valid values: 0-9 Int32 Int32 SetFlagOnMatch If the rule is successfully matched, set the specified flag. Using the OnlyOnFlag and SetFlagOnMatch parameters, it is possible to make rules dependent on each other, that is, only execute a particular rule if another rule has been successfully matched. For more detailed instructions on ‘chaining’ rules, please refer to the Content Rules, Feature Description document on the KEMP Documentation Page: https://kemptechnologies.com/loadmaster-documentation/. Valid values: 0-9 Int32 Int32 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String Name The name of the rule. string string -------------------------- Example -------------------------- PS C:\> New-AdcContentRule -Name ExampleRule -MatchType regex -Pattern ExamplePattern -Replacement ExampleReplacement Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. New-AdcHttpCacheException Add an extension to the "Do Not Cache" extension list. New AdcHttpCacheException Add the specified extension to the list. New-AdcHttpCacheException Extension The file extension that should not be cached, for example, .jpg. The extension must start with a full stop (.). A collection of extensions can be provided through the pipeline. String[] LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String New-AdcHttpCacheException Extension The file extension that should not be cached, for example, .jpg. The extension must start with a full stop (.). A collection of extensions can be provided through the pipeline. String[] LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String Extension The file extension that should not be cached, for example, .jpg. The extension must start with a full stop (.). A collection of extensions can be provided through the pipeline. String[] String[] LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> New-AdcHttpCacheException -Extension .mp4 Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. New-AdcHttpCompressionException Allows you to add an extension to the "Do Not Compress" extension list. New AdcHttpCompressionException Add the specified extension. New-AdcHttpCompressionException Extension The file extension that should not be compressed, for example,.jpg. The extension must start with a full stop (.). A collection of extensions can be provided through the pipeline. This parameter is required. String[] LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String New-AdcHttpCompressionException Extension The file extension that should not be compressed, for example,.jpg. The extension must start with a full stop (.). A collection of extensions can be provided through the pipeline. This parameter is required. String[] LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String Extension The file extension that should not be compressed, for example,.jpg. The extension must start with a full stop (.). A collection of extensions can be provided through the pipeline. This parameter is required. String[] String[] LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> New-AdcHttpCompressionException -Extension .mp4 Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. New-AdcRealServer Add a new Real Server configuration. New AdcRealServer Configures a new Real Server that can handle traffic for a service. New-AdcRealServer VirtualService The IP address of the Virtual Service. String VSPort The port of the Virtual Service to add the Real Server to. Int32 VSProtocol The protocol of the Virtual Service to add the Real Server to. String VSIndex The index number of the Virtual Service or SubVS. To retrieve the VSIndex, run the Get-VirtualService command. Int32 RealServer The IP address that the Real Server being defined listens on. String RealServerPort The port that the Real Server will be listening on. Int32 Weight The Real Server's weight. This is weight of the Real Server, as used by the Weighted Round Robin, Weighted Least Connection and Adaptive scheduling methods. The default initial value for the weight is 1000, the maximum is 65535 and the minimum is 1. Int32 Forward Either NAT (Network Address Translation) or Route (Direct) forwarding. The available options are dependent on the other modes configured for the service. String Enable Specifies if the Real Server is enabled or disabled. Pass in a value of TRUE ($true) for enabled, and FALSE ($false) for disabled. Boolean Non_Local By default only Real Servers on local networks can be assigned to a Virtual Service. Enabling this option will allow a non-local Real Server to be assigned to the Virtual Service. Note: This option will only be available if nonlocalrs has been enabled and the Transparent option has been disabled on the relevant Virtual Service. Boolean Limit The maximum number of open connections that a Real Server will accept before it is taken out of the rotation. This is only available for Layer 7 traffic. Int64 Critical True or false to indicate whether this Real Server is required for the Virtual Service to be available. Boolean Follow Specify what Real Server the health check is based on by setting this parameter to the RsIndex of the Real Server to be followed. This can either be set to the RsIndex of the same Real Server in order to health check based on that particular Real Server status, or another Real Server can be specified. For example – if Real Server 1 is down, any Real Servers which have their health check based on Real Server 1 will also be marked as down, regardless of their actual Real Server status. Int32 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String New-AdcRealServer VirtualService The IP address of the Virtual Service. String VSPort The port of the Virtual Service to add the Real Server to. Int32 VSProtocol The protocol of the Virtual Service to add the Real Server to. String VSIndex The index number of the Virtual Service or SubVS. To retrieve the VSIndex, run the Get-VirtualService command. Int32 RealServer The IP address that the Real Server being defined listens on. String RealServerPort The port that the Real Server will be listening on. Int32 Weight The Real Server's weight. This is weight of the Real Server, as used by the Weighted Round Robin, Weighted Least Connection and Adaptive scheduling methods. The default initial value for the weight is 1000, the maximum is 65535 and the minimum is 1. Int32 Forward Either NAT (Network Address Translation) or Route (Direct) forwarding. The available options are dependent on the other modes configured for the service. String Enable Specifies if the Real Server is enabled or disabled. Pass in a value of TRUE ($true) for enabled, and FALSE ($false) for disabled. Boolean Non_Local By default only Real Servers on local networks can be assigned to a Virtual Service. Enabling this option will allow a non-local Real Server to be assigned to the Virtual Service. Note: This option will only be available if nonlocalrs has been enabled and the Transparent option has been disabled on the relevant Virtual Service. Boolean Limit The maximum number of open connections that a Real Server will accept before it is taken out of the rotation. This is only available for Layer 7 traffic. Int64 Critical True or false to indicate whether this Real Server is required for the Virtual Service to be available. Boolean Follow Specify what Real Server the health check is based on by setting this parameter to the RsIndex of the Real Server to be followed. This can either be set to the RsIndex of the same Real Server in order to health check based on that particular Real Server status, or another Real Server can be specified. For example – if Real Server 1 is down, any Real Servers which have their health check based on Real Server 1 will also be marked as down, regardless of their actual Real Server status. Int32 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String VirtualService The IP address of the Virtual Service. String String VSPort The port of the Virtual Service to add the Real Server to. Int32 Int32 VSProtocol The protocol of the Virtual Service to add the Real Server to. String String VSIndex The index number of the Virtual Service or SubVS. To retrieve the VSIndex, run the Get-VirtualService command. Int32 Int32 RealServer The IP address that the Real Server being defined listens on. String String RealServerPort The port that the Real Server will be listening on. Int32 Int32 Weight The Real Server's weight. This is weight of the Real Server, as used by the Weighted Round Robin, Weighted Least Connection and Adaptive scheduling methods. The default initial value for the weight is 1000, the maximum is 65535 and the minimum is 1. Int32 Int32 Forward Either NAT (Network Address Translation) or Route (Direct) forwarding. The available options are dependent on the other modes configured for the service. String String Enable Specifies if the Real Server is enabled or disabled. Pass in a value of TRUE ($true) for enabled, and FALSE ($false) for disabled. Boolean Boolean Non_Local By default only Real Servers on local networks can be assigned to a Virtual Service. Enabling this option will allow a non-local Real Server to be assigned to the Virtual Service. Note: This option will only be available if nonlocalrs has been enabled and the Transparent option has been disabled on the relevant Virtual Service. Boolean Boolean Limit The maximum number of open connections that a Real Server will accept before it is taken out of the rotation. This is only available for Layer 7 traffic. Int64 Int64 Critical True or false to indicate whether this Real Server is required for the Virtual Service to be available. Boolean Boolean Follow Specify what Real Server the health check is based on by setting this parameter to the RsIndex of the Real Server to be followed. This can either be set to the RsIndex of the same Real Server in order to health check based on that particular Real Server status, or another Real Server can be specified. For example – if Real Server 1 is down, any Real Servers which have their health check based on Real Server 1 will also be marked as down, regardless of their actual Real Server status. Int32 Int32 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String Port The port that the Virtual Service is listening on. int32 int32 Protocol Specify if the service is using TCP or UDP protocols. string string -------------------------- Example -------------------------- PS C:\> New-AdcRealServer -Port 443 -Protocol tcp -RealServer 10.154.11.85 -RealServerPort 443 -VirtualService 10.154.11.181 Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Data field...: @{RsSettings=} Param........: @{Status=Down; VSIndex=1; RsIndex=7; Addr=10.154.11.85; Port=443; DnsName=; Forward=nat; Weight=1000; Limit=0; Follow=0; Enable=Y; Critic al=N} New-AdcRealServerRule Allows you to add a preconfigured rule to a Real Server. New AdcRealServerRule Allows you to add a preconfigured rule to a Real Server or a SubVS. New-AdcRealServerRule VirtualService The IP Address of the Virtual Service this rule should be applied to. String VSPort The port of the relevant Virtual Service. Int32 VSProtocol The protocol of the relevant Virtual Service. String VSIndex The index number of the relevant Virtual Service or SubVS. To retrieve the VSIndex, run the Get-VirtualService command. Int32 RealServer The Real Server to which this Virtual Service connects to. String RSPort The port on which the Real Server accepts connections for this Virtual Service. Int32 RSIndex The index number of the Real Server or SubVS to add the rule to. To retrieve the Real Server index, run the Get-VirtualService command. Int32 RuleName The name of the rule that should be applied to the Virtual Service. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String New-AdcRealServerRule VirtualService The IP Address of the Virtual Service this rule should be applied to. String VSPort The port of the relevant Virtual Service. Int32 VSProtocol The protocol of the relevant Virtual Service. String VSIndex The index number of the relevant Virtual Service or SubVS. To retrieve the VSIndex, run the Get-VirtualService command. Int32 RealServer The Real Server to which this Virtual Service connects to. String RSPort The port on which the Real Server accepts connections for this Virtual Service. Int32 RSIndex The index number of the Real Server or SubVS to add the rule to. To retrieve the Real Server index, run the Get-VirtualService command. Int32 RuleName The name of the rule that should be applied to the Virtual Service. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String VirtualService The IP Address of the Virtual Service this rule should be applied to. String String VSPort The port of the relevant Virtual Service. Int32 Int32 VSProtocol The protocol of the relevant Virtual Service. String String VSIndex The index number of the relevant Virtual Service or SubVS. To retrieve the VSIndex, run the Get-VirtualService command. Int32 Int32 RealServer The Real Server to which this Virtual Service connects to. String String RSPort The port on which the Real Server accepts connections for this Virtual Service. Int32 Int32 RSIndex The index number of the Real Server or SubVS to add the rule to. To retrieve the Real Server index, run the Get-VirtualService command. Int32 Int32 RuleName The name of the rule that should be applied to the Virtual Service. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String Port The port on which this Virtual Service accepts connections. int32 int32 Protocol The protocol for communication. Accepts either TCP or UDP. This is not case sensitive. string string -------------------------- Example -------------------------- PS C:\> New-AdcRealServerRule -Port 80 -Protocol tcp -RealServer 10.11.0.24 -RSPort 80 -RuleName TestRule2 -VirtualService 10.11.0.200 Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. New-AdcSubVirtualService Add a new SubVS. New AdcSubVirtualService This command adds a SubVS to the specified Virtual Service. New-AdcSubVirtualService VirtualService The address of the Virtual Service to add the SubVS to. String VSPort The port of the Virtual Service to add the SubVS to. Int32 VSProtocol The protocol of the Virtual Service to add the SubVS to. String VSIndex The ID number of the Virtual Service to add the SubVS to. Int32 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String New-AdcSubVirtualService VirtualService The address of the Virtual Service to add the SubVS to. String VSPort The port of the Virtual Service to add the SubVS to. Int32 VSProtocol The protocol of the Virtual Service to add the SubVS to. String VSIndex The ID number of the Virtual Service to add the SubVS to. Int32 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String VirtualService The address of the Virtual Service to add the SubVS to. String String VSPort The port of the Virtual Service to add the SubVS to. Int32 Int32 VSProtocol The protocol of the Virtual Service to add the SubVS to. String String VSIndex The ID number of the Virtual Service to add the SubVS to. Int32 Int32 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> New-AdcSubVirtualService -VirtualService 10.154.11.90 -VSPort 80 -VSProtocol tcp Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Status : Down Index : 1 VSAddress : 10.154.11.90 VSPort : 80 Layer : 7 Enable : Y SSLReverse : N SSLReencrypt : N Intercept : N InterceptOpts : @{Opt=System.Object[]} AlertThreshold : 0 Transactionlimit : 0 Transparent : Y SubnetOriginating : N ServerInit : 0 StartTLSMode : 0 Idletime : 660 Cache : N Compress : N Verify : 0 UseforSnat : N ForceL4 : N ForceL7 : Y MultiConnect : N ClientCert : 0 ErrorCode : 0 CheckUse1.1 : N MatchLen : 0 CheckUseGet : 0 SSLRewrite : 0 VStype : http FollowVSID : 0 Protocol : tcp Schedule : rr CheckType : http Persist : header PersistTimeout : 360 CheckPort : 0 NRules : 0 NRequestRules : 0 NResponseRules : 0 NPreProcessRules : 0 EspEnabled : N InputAuthMode : 0 OutputAuthMode : 0 MasterVS : 1 MasterVSID : 0 IsTransparent : 0 AddVia : 0 QoS : 0 TlsType : 0 NeedHostName : N OCSPVerify : N AllowHTTP2 : N RsMinimum : 0 NumberOfRSs : 1 SubVS : @{Status=Down; VSIndex=2; RsIndex=1; Name=-; Forward=nat; Weight=1000; Limit=0; Follow=0; Enable=Y; Critical=N} New-AdcVirtualService Create and configure a new Virtual Service. New AdcVirtualService Creates a new Virtual Service that can accept requests and send them to available Real Servers. New-AdcVirtualService VirtualService The IP address for the Virtual Service. String VSPort The port of the new Virtual Service. Int32 VSProtocol The protocol of the new Virtual Service. String AddVia Specifies which headers are added to the HTTP stream. Choose the number of the option to use. 0 - Legacy Operation(XXX) 1 - None 2 - X-Forwarded-For 3 - X-Forwarded-For (No Via) 4 - X-ClientSide 5 - X-ClientSide (No Via) 6 - Via Only Int16 Template Specifies a template name. String Cache Enables or disables caching on this Virtual Service. Boolean CertFile Specifies the name of the certificate file to use that is already installed on the load balancer. Note: This will NOT upload a certificate file to the load balancer. String CheckType Specifies the protocol to use to check if the service is up. Valid options are "tcp", "icmp", "https", "http", "smtp", "nntp", "ftp", "telnet", "pop3", "imap", "rdp", or "none". String CheckHost The address to use to check if the service is up. String CheckPattern A regular expression string that can be validate on a 200 reply to determine if the service is up. String CheckUrl The URL to check if the service is up. The maximum character length for the CheckUrl parameter value is 126 characters. String CheckHeaders Specify up to four additional headers/fields which will be sent with each health check request. Separate the pairs with a pipe, for example; Host:xyc|UserAgent:prq. String LdapEndpoint Specify the name of an LDAP endpoint to use for the health checks. If LDAP is selected as the CheckType, the server IP address (or addresses) and ports from the LDAP endpoint configuration are used instead of the Real Server IP address and port. String MatchLen This parameter is only relevant when the CheckType is set to "bdata". Specify the number of bytes to find the CheckPattern within. String CheckUse1_1 Specifies that the health checker use HTTP/1.1 instead of HTTP/1.0. 0 - HTTP/1.0 1 - HTTP/1.1 Int32 CheckPort The port to use to check if the service is up. Int32 EnhancedHealthChecks Enables or disables Enhanced Health Check Options for the Virtual Service. Boolean RsMinimum Specifies the minimum number of Real Servers that are required to be active for the Virtual Service to be considered up. Int32 ClientCert Specify how client certificates should be used. Valid values are 0, 1, or 2. Zero indicates that client certificates are not use. One indicates that client certificates are required. Two indicates that client certificates are required and additional HEAD information is being sent. Int16 Compress Enable or disable file compression for the Virtual Service. Boolean Cookie Specifies a cookie name. This parameter is only relevant when the persistence mode is set to "cookie", "active-cookie", "cookie-src" or "active-cook-src". String CachePercent Specifies the maximum cache usage for this Virtual Service. Note: Setting two Virtual Services using 50% of cache will use 100% of all cache storage. This parameter accepts values from 0 to 100. Int16 DefaultGW Specifies a Virtual Service-specific default gateway to be used to send responses back to clients. If not set, the global default gateway will be used. String Enable Enables or disables the Virtual Service. Boolean ErrorCode If no Real Servers are available, the LoadMaster can terminate the connection with an HTTP error code. Specify the error code number in this parameter. String ErrorUrl When no Real Servers are available and an error response is sent back to the client, a redirect URL can also be specified. String PortFollow This parameter was depreciated as of 7.1-24. For LoadMasters with version 7.1-24 or higher, use the FollowVSID parameter to set port following. Int32 ForceL7 Enabling ForceL7 means the Virtual Service runs at Layer 7 and not Layer 4. This may be needed for various reasons, including that only Layer 7 services can be non-transparent. Boolean Idletime Specifies the length of time (in seconds) that a connection may remain idle before it is closed. The range for this parameter is 0 to 86400. There are some special values that can be set for this parameter: - 0: Ensures the default L7 connection timeout is used. The default timeout value can be modified by setting the conntimeout parameter. - 1: Discards the connection after the packet is first forwarded – a response is not expected or handled. - 2: Uses a DNS-type of operation. The connection is dropped after the reply message. Setting it to 1 or 2 enables better performance and memory usage for UDP connections and they correspond better to how UDP is used. Int32 LocalBindAddresses Specifies a space separated list of IP addresses. This corresponds to the Alternate Source Address in the Advanced Properties section of the WUI. Allow connections scaling over 64K Connections needs to be enabled in L7 Configuration for this feature to work. String[] VSType Specifies the type of service being load balanced: gen - Generic http - HTTP/HTTPS ts - Remote Terminal tls – STARTTLS protocols log – Log Insight String Nickname Specifies the "friendly" name of the service. In addition to the usual alphanumeric characters, the following "special" characters can be used as part of the Service Name: . @ - _ However, there must be at least one alphanumeric character before the special characters. String Persist Specifies the type of persistence (stickiness) to be used for this Virtual Service. The following persistence values are supported: ssl, cookie, active-cookie, cookie-src, active-cook-src, cookie-hash, cookie-hash-src, url, query-hash, host, header, super, super-src, src, rdp, rdp-src, rdp-sb, rdp-sb-src and udpsip. Note: If setting the persistence mode to an option that requires a cookie (or query-hash), the cookie parameter must also be set. String PersistTimeout The length of time (in seconds) after the last connection that the LoadMaster will remember the persistence information. Timeout values are rounded down to an even number of minutes. Setting a value that is not a number of whole minutes results in the excess being ignored. Setting a value to less than 60 seconds results in a value of 0 being set, which disables persistency. Int32 QueryTag This is the query tag to be matched if the Persist type is set to query-hash. String CipherSet Specifies a cipher set name. String SSLReencrypt This parameter is only relevant if SSL Acceleration is enabled. When this option is enabled, the SSL data stream is re-encrypted before sending to the Real Server. Boolean SSLReverse Enabling this parameter means that the data from the LoadMaster to the Real Server is re-encrypted. Boolean SSLRewrite When the Real Server rejects a request with an HTTP redirect, the requesting Location URL may need to be converted to specify HTTPS instead of HTTP (and vice versa). String ReverseSNIHostname If this option is enabled, the host name is required to be sent in the TLS client hello message. If it is not sent the connection will be dropped. String Schedule Specifies the type of scheduling of new connections to Real Servers that is to be performed. The following values are supported: rr = round robin wrr = weighted round robin lc = least connection wlc = weighted least connection fixed = fixed weighting adaptive = resource based (adaptive) sh = source IP hash dl = weighted response time sdn-adaptive = resource based (SDN adaptive) String ServerInit Specifies one of the following values: 0 = Normal Protocols 1 = SMTP 2 = SSH 3 = Other Server Initiating 4 = IMAP4 5 = MySQL 6 = POP3 Int16 SSLAcceleration Specifies whether to enable SSL handling on the Virtual Service. Boolean StandByAddr Specifies the IP address of the "Sorry" server that is to be used when no other Real Servers are available. This server will not be health checked and is assumed to be always available. String StandByPort Specifies the port of the "Sorry" server. String TransactionLimit This is a legacy parameter that should no longer be used. It was used previously when the SSL proxy was limited to 6K total connections. The transaction limit was used to limit one Virtual Service to only handle so many connections out of this 6K. On newer systems, where the limit is greater than 64K - this feature is no longer required. Int32 Transparent When using Layer 7, when this is enabled - the connection arriving at the Real Server appears to come directly from the client. Alternatively, the connection can be non-transparent, which means that the connections at the Real Server appear to come from the LoadMaster. 0 - Disabled 1 - Enabled If a Virtual Service (with or without a SubVS) has SSL re-encrypt enabled, the transparency flag of the Virtual Service has no meaning (re-encryption forces transparency to be off). The transparency setting can still be modified by the API, and is honored when re-encrypt is disabled on the Virtual Service. Boolean SubnetOriginating When transparency is not enabled, the source IP address of connections to the Real Servers is that of the Virtual Service. When transparency is enabled, the source IP address will be the IP address that is initiating connection to the Virtual Service. If the Real Server is on a subnet, and the Subnet Originating Requests option is enabled, then the subnet address of the LoadMaster will be used as the source IP address. Boolean UseforSnat By default, when the LoadMaster is being used to NAT Real Servers, the source IP address used on the Internet is that of the LoadMaster. Enabling this option allows the Real Servers configured to use the Virtual Service as the source IP address instead. If the Real Servers are configured on more than one Virtual Service which has this option set, only connections to destination port 80 will use this Virtual Service as the source IP address. Boolean QoS Specifies the Quality of Service. The following values are supported: 0 - Normal-Service 1 - Minimize-Cost 2 - Maximize-Reliability 4 - Maximize-Throughput 8 - Minimize-Delay String CheckUseGet When accessing the health check URL - the system can use the HEAD, the GET or the POST method: 0 - HEAD 1 - GET 2 - POST Int32 Verify Specifies a verification bitmask. The valid values of the Verify parameter are as follows: Bit 0: set this to 1 to enable detection intrusion. Note: Bit 0 needs to be set to 1 in order to use the other two bits. Bit 1: Determines whether to reject or drop a connection. Setting it to 1 will drop the connection. Bit 2: Determines whether to give just warnings on bad requests or also on malicious (but not invalid) requests. The following table lists the valid integers and the values they set the fields to when used: Integer Detect Malicious Requests Intrusion Handling Warnings Checkbox 0 Disabled N/A N/A 1 Enabled Drop Connection Unchecked 2 Enabled Send Reject Unchecked 3 Enabled Send Reject Unchecked 4 Enabled Drop Connection Checked 5 Enabled Drop Connection Checked 6 Enabled Send Reject Checked 7 Enabled Send Reject Checked Int16 ExtraHdrKey Specifies the key for the extra header to be inserted into every request sent to the Real Servers. String ExtraHdrValue Specifies the value for the extra header to be inserted into every request sent to the Real Servers. String AllowedHosts This parameter is only relevant when ESP is enabled. Specifies all the virtual hosts that can be accessed via this Virtual Service. String AllowedDirectories This parameter is only relevant when ESP is enabled. Specifies all the virtual directories that can be accessed via this Virtual Service. String AllowedGroups Specifies the groups that are allowed to access this Virtual Service. String GroupSIDs Specify the group security identifier (SIDs) that are allowed to access this Virtual Service. Each group must be separated by a semicolon. String SteeringGroups Enter the Active Directory group names that will be used for steering traffic. Use a semi-colon to separate multiple group names. The steering group index number corresponds to the location of the group in this list. String IncludeNestedGroups Specify if nested groups should be included in the authentication attempt. Boolean DisplayPubPriv Display the public/private option on the login page. Based on the option the user selects on the login form, the session timeout value will be set to the value specified for either the public or private timeout. Boolean DisablePasswordForm Enabling this option removes the password field from the login page. This may be needed when password validation is not required, for example if using RSA SecurID authentication in a singular fashion. Boolean Domain Specifies the Single Sign On (SSO) domain in which this Virtual Service will operate. String AltDomains Specifies alternative domains to be assigned to a Virtual Service when configuring multi-domain authentication. To specify multiple alternative domains use a space-separated list. String Logoff This parameter is only relevant when ESP is enabled and when the Client Authentication Mode is set to Form Based. Specify the string that the LoadMaster should use to detect a logout event. Multiple logoff strings can be specified by using a space-separated list. If the URL to be matched contains sub-directories before the specified string, the Logoff String will not be matched. Therefore the LoadMaster will not log the user off. String ESPLogs Enable ESP logging. Valid values are below: 0 - Logging off 1 - User Access 2 - Security 3 - User Access and Security 4 - Connection 5 - User Access and Connection 6 - Security and connection 7 - User Access, Security and Connection Note: The only valid values for SMTP services are 0 and 4. For SMTP services, security issues are always logged. Nothing is logged for user access because there are no logins. Int16 SMTPAllowedDomains Specifies all the permitted domains that are allowed to be received by this Virtual Service. String ESPEnabled Specifies whether to enable or disable the Edge Security Pack (ESP) features. Boolean UserPwdChangeUrl This is relevant when using form-based or LDAP authentication. Specify the URL that users can use to change their password. If a user’s password has expired, or if they must reset their password, this URL and the UserPwdChangeMsg is displayed on the login form. This URL must be put into the exception list for authentication, if required. String UserPwdChangeMsg This parameter is only relevant if the UserPwdChangeURL parameter is set. Specify the text to be displayed on the login form when the user must reset their password. String SecurityHeaderOptions Enable this option to add the Strict-Transport-Security header to all LoadMaster-generated messages (ESP and error messages). 0 - Don't add the Strict Transport Security Header (default value) 1 - Add the Strict Transport Security Header - no subdomains 2 - Add the Strict Transport Security Header - include subdomains Enable this option to add the Strict-Transport-Security header to all LoadMaster-generated messages (ESP and error messages). Int16 InputAuthMode Specifies the client authentication method to be used: 0 - Delegate to Server 1 - Basic Authentication 2 - Form Based 4 - Client Certificate 5 - NTLM 6 - SAML Int16 OutConf String OutputAuthMode Specifies the server authentication mode to be used: 0 - None 1 - Basic Authentication 2 - Form Based 2 - KCD Int16 StartTLSMode 0 - HTTP/HTTPS (the Service Type needs to be set to HTTP/HTTPS for this to work) The Virtual Service Type must be set to STARTTLS for the remaining values to be set: 1 - SMTP (STARTTLS if requested) 2 - SMTP (STARTTLS always) 3 - FTP 4 - IMAP 6 - POP3 Int16 ExtraPorts Specifies extra ports that the Virtual Service will listen to. String AltAddress Specifies the alternate address for this Virtual Service. String MultiConnect Enabling this option permits the LoadMaster to manage connection handling between the LoadMaster and the Real Servers. Requests from multiple clients will be sent over the same TCP connection. Multiplexing only works for simple HTTP GET operations. This parameter cannot be enabled in certain situations, for example if WAF, ESP or SSL Acceleration is enabled. Boolean SingleSignOnDir This parameter relates to the SSO Image Set drop-down in the ESP Options section of the modify Virtual Service screen. Specify the name of the image set to be used for the login screen. If no image set is specified, the default Exchange image set will be used. String OCSPVerify Specifies whether to verify (via Online Certificate Status Protocol (OCSP)) that the client certificate is valid. String FollowVSID Specifies the ID of the Virtual Service to follow. Int32 TlsType Specify which of the following protocols to support; SSLv3, TLS1.0, TLS1.1 or TLS1.2. By default, TLS1.1 and TLS1.2 are enabled. The protocols can be enabled and disabled using a bitmask value. Refer to the table below to find out what number corresponds to which settings. Number | SSLv3 | TLS1.0 | TLS1.1 | TLS1.2 0 | Enabled | Enabled | Enabled | Enabled 1 | Disabled | Enabled | Enabled | Enabled 2 | Enabled | Disabled | Enabled | Enabled 3 | Disabled | Disabled | Enabled | Enabled 4 | Enabled | Enabled | Disabled | Enabled 5 | Disabled | Enabled | Disabled | Enabled 6 | Enabled | Disabled | Disabled | Enabled 7 | Disabled | Disabled | Disabled | Enabled 8 | Enabled | Enabled | Enabled | Disabled 9 | Disabled | Enabled | Enabled | Disabled 10 | Enabled | Disabled | Enabled | Disabled 11 | Disabled | Disabled | Enabled | Disabled 12 | Enabled | Enabled | Disabled | Disabled 13 | Disabled | Enabled | Disabled | Disabled 14 | Enabled | Disabled | Disabled | Disabled Int32 CheckPostData This parameter is only relevant if the HTTP Method is set to POST. When using the POST method, up to 2047 characters of POST data can be sent to the server. String CheckCodes A space-separated list of HTTP status codes that should be treated as successful when received from the Real Server. Range: 300-599 String PreProcPrecedence This parameter should be used in conjunction with PreProcPrecedencePos. This parameter is used to specify the name of the existing rule whose position you wish to change. This parameter relates to Content Matching Rules only. String PreProcPrecedencePos This parameter, in conjunction with the PreProcPrecedence parameter, is used to change the position of the rule in a sequence of rules. For example a position of 2 means the rule will be checked second. This parameter relates to the Content Matching Rules only. Int16 RequestPrecedence This parameter should be used in conjunction with RequestPrecedencePos. This parameter is used to specify the name of the existing request rule whose position you wish to change. This parameter relates to the following rule types: Content Matching Add Header Delete Header Replace Header Modify URL String RequestPrecedencePos This parameter, in conjunction with the RequestPrecedence parameter, is used to change the position of the rule in a sequence of rules. For example a position of 2 means the rule will be checked second. Int16 ResponsePrecedence This parameter should be used in conjunction with ResponsePrecedencePos. This parameter is used to specify the name of the existing response rule whose position you wish to change. This parameter relates to the following rule types: Content Matching Add Header Delete Header Replace Header String ResponsePrecedencePos This parameter, in conjunction with the ResponsePrecedence parameter, is used to change the position of the rule in a sequence of rules. For example, a position of 2 means the rule will be checked second. Int16 RsRulePrecedence This parameter should be used in conjunction with RSRulePrecedencePos. This parameter is used to specify the name of the existing rule whose position you wish to change. String RsRulePrecedencePos This parameter, in conjunction with the RSRulePrecedence parameter, is used to change the position of the rule in a sequence of rules. For example, a position of 2 means the rule will be checked second. Int16 NeedHostName When this parameter is enabled, the hostname is always required to be sent in the TLS client hello message. If it is not sent, the connection is dropped. Valid values: 0 - Disabled 1 - Enabled Boolean CopyHdrFrom This is the name of the source header field to copy into the new header field before the request is sent to the Real Servers. String CopyHdrTo This parameter is used in conjunction with the CopyHdrFrom parameter. The name of the header field into which the source header is to be copied. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String New-AdcVirtualService VirtualService The IP address for the Virtual Service. String VSPort The port of the new Virtual Service. Int32 VSProtocol The protocol of the new Virtual Service. String AddVia Specifies which headers are added to the HTTP stream. Choose the number of the option to use. 0 - Legacy Operation(XXX) 1 - None 2 - X-Forwarded-For 3 - X-Forwarded-For (No Via) 4 - X-ClientSide 5 - X-ClientSide (No Via) 6 - Via Only Int16 Template Specifies a template name. String Cache Enables or disables caching on this Virtual Service. Boolean CertFile Specifies the name of the certificate file to use that is already installed on the load balancer. Note: This will NOT upload a certificate file to the load balancer. String CheckType Specifies the protocol to use to check if the service is up. Valid options are "tcp", "icmp", "https", "http", "smtp", "nntp", "ftp", "telnet", "pop3", "imap", "rdp", or "none". String CheckHost The address to use to check if the service is up. String CheckPattern A regular expression string that can be validate on a 200 reply to determine if the service is up. String CheckUrl The URL to check if the service is up. The maximum character length for the CheckUrl parameter value is 126 characters. String CheckHeaders Specify up to four additional headers/fields which will be sent with each health check request. Separate the pairs with a pipe, for example; Host:xyc|UserAgent:prq. String LdapEndpoint Specify the name of an LDAP endpoint to use for the health checks. If LDAP is selected as the CheckType, the server IP address (or addresses) and ports from the LDAP endpoint configuration are used instead of the Real Server IP address and port. String MatchLen This parameter is only relevant when the CheckType is set to "bdata". Specify the number of bytes to find the CheckPattern within. String CheckUse1_1 Specifies that the health checker use HTTP/1.1 instead of HTTP/1.0. 0 - HTTP/1.0 1 - HTTP/1.1 Int32 CheckPort The port to use to check if the service is up. Int32 EnhancedHealthChecks Enables or disables Enhanced Health Check Options for the Virtual Service. Boolean RsMinimum Specifies the minimum number of Real Servers that are required to be active for the Virtual Service to be considered up. Int32 ClientCert Specify how client certificates should be used. Valid values are 0, 1, or 2. Zero indicates that client certificates are not use. One indicates that client certificates are required. Two indicates that client certificates are required and additional HEAD information is being sent. Int16 Compress Enable or disable file compression for the Virtual Service. Boolean Cookie Specifies a cookie name. This parameter is only relevant when the persistence mode is set to "cookie", "active-cookie", "cookie-src" or "active-cook-src". String CachePercent Specifies the maximum cache usage for this Virtual Service. Note: Setting two Virtual Services using 50% of cache will use 100% of all cache storage. This parameter accepts values from 0 to 100. Int16 DefaultGW Specifies a Virtual Service-specific default gateway to be used to send responses back to clients. If not set, the global default gateway will be used. String Enable Enables or disables the Virtual Service. Boolean ErrorCode If no Real Servers are available, the LoadMaster can terminate the connection with an HTTP error code. Specify the error code number in this parameter. String ErrorUrl When no Real Servers are available and an error response is sent back to the client, a redirect URL can also be specified. String PortFollow This parameter was depreciated as of 7.1-24. For LoadMasters with version 7.1-24 or higher, use the FollowVSID parameter to set port following. Int32 ForceL7 Enabling ForceL7 means the Virtual Service runs at Layer 7 and not Layer 4. This may be needed for various reasons, including that only Layer 7 services can be non-transparent. Boolean Idletime Specifies the length of time (in seconds) that a connection may remain idle before it is closed. The range for this parameter is 0 to 86400. There are some special values that can be set for this parameter: - 0: Ensures the default L7 connection timeout is used. The default timeout value can be modified by setting the conntimeout parameter. - 1: Discards the connection after the packet is first forwarded – a response is not expected or handled. - 2: Uses a DNS-type of operation. The connection is dropped after the reply message. Setting it to 1 or 2 enables better performance and memory usage for UDP connections and they correspond better to how UDP is used. Int32 LocalBindAddresses Specifies a space separated list of IP addresses. This corresponds to the Alternate Source Address in the Advanced Properties section of the WUI. Allow connections scaling over 64K Connections needs to be enabled in L7 Configuration for this feature to work. String[] VSType Specifies the type of service being load balanced: gen - Generic http - HTTP/HTTPS ts - Remote Terminal tls – STARTTLS protocols log – Log Insight String Nickname Specifies the "friendly" name of the service. In addition to the usual alphanumeric characters, the following "special" characters can be used as part of the Service Name: . @ - _ However, there must be at least one alphanumeric character before the special characters. String Persist Specifies the type of persistence (stickiness) to be used for this Virtual Service. The following persistence values are supported: ssl, cookie, active-cookie, cookie-src, active-cook-src, cookie-hash, cookie-hash-src, url, query-hash, host, header, super, super-src, src, rdp, rdp-src, rdp-sb, rdp-sb-src and udpsip. Note: If setting the persistence mode to an option that requires a cookie (or query-hash), the cookie parameter must also be set. String PersistTimeout The length of time (in seconds) after the last connection that the LoadMaster will remember the persistence information. Timeout values are rounded down to an even number of minutes. Setting a value that is not a number of whole minutes results in the excess being ignored. Setting a value to less than 60 seconds results in a value of 0 being set, which disables persistency. Int32 QueryTag This is the query tag to be matched if the Persist type is set to query-hash. String CipherSet Specifies a cipher set name. String SSLReencrypt This parameter is only relevant if SSL Acceleration is enabled. When this option is enabled, the SSL data stream is re-encrypted before sending to the Real Server. Boolean SSLReverse Enabling this parameter means that the data from the LoadMaster to the Real Server is re-encrypted. Boolean SSLRewrite When the Real Server rejects a request with an HTTP redirect, the requesting Location URL may need to be converted to specify HTTPS instead of HTTP (and vice versa). String ReverseSNIHostname If this option is enabled, the host name is required to be sent in the TLS client hello message. If it is not sent the connection will be dropped. String Schedule Specifies the type of scheduling of new connections to Real Servers that is to be performed. The following values are supported: rr = round robin wrr = weighted round robin lc = least connection wlc = weighted least connection fixed = fixed weighting adaptive = resource based (adaptive) sh = source IP hash dl = weighted response time sdn-adaptive = resource based (SDN adaptive) String ServerInit Specifies one of the following values: 0 = Normal Protocols 1 = SMTP 2 = SSH 3 = Other Server Initiating 4 = IMAP4 5 = MySQL 6 = POP3 Int16 SSLAcceleration Specifies whether to enable SSL handling on the Virtual Service. Boolean StandByAddr Specifies the IP address of the "Sorry" server that is to be used when no other Real Servers are available. This server will not be health checked and is assumed to be always available. String StandByPort Specifies the port of the "Sorry" server. String TransactionLimit This is a legacy parameter that should no longer be used. It was used previously when the SSL proxy was limited to 6K total connections. The transaction limit was used to limit one Virtual Service to only handle so many connections out of this 6K. On newer systems, where the limit is greater than 64K - this feature is no longer required. Int32 Transparent When using Layer 7, when this is enabled - the connection arriving at the Real Server appears to come directly from the client. Alternatively, the connection can be non-transparent, which means that the connections at the Real Server appear to come from the LoadMaster. 0 - Disabled 1 - Enabled If a Virtual Service (with or without a SubVS) has SSL re-encrypt enabled, the transparency flag of the Virtual Service has no meaning (re-encryption forces transparency to be off). The transparency setting can still be modified by the API, and is honored when re-encrypt is disabled on the Virtual Service. Boolean SubnetOriginating When transparency is not enabled, the source IP address of connections to the Real Servers is that of the Virtual Service. When transparency is enabled, the source IP address will be the IP address that is initiating connection to the Virtual Service. If the Real Server is on a subnet, and the Subnet Originating Requests option is enabled, then the subnet address of the LoadMaster will be used as the source IP address. Boolean UseforSnat By default, when the LoadMaster is being used to NAT Real Servers, the source IP address used on the Internet is that of the LoadMaster. Enabling this option allows the Real Servers configured to use the Virtual Service as the source IP address instead. If the Real Servers are configured on more than one Virtual Service which has this option set, only connections to destination port 80 will use this Virtual Service as the source IP address. Boolean QoS Specifies the Quality of Service. The following values are supported: 0 - Normal-Service 1 - Minimize-Cost 2 - Maximize-Reliability 4 - Maximize-Throughput 8 - Minimize-Delay String CheckUseGet When accessing the health check URL - the system can use the HEAD, the GET or the POST method: 0 - HEAD 1 - GET 2 - POST Int32 Verify Specifies a verification bitmask. The valid values of the Verify parameter are as follows: Bit 0: set this to 1 to enable detection intrusion. Note: Bit 0 needs to be set to 1 in order to use the other two bits. Bit 1: Determines whether to reject or drop a connection. Setting it to 1 will drop the connection. Bit 2: Determines whether to give just warnings on bad requests or also on malicious (but not invalid) requests. The following table lists the valid integers and the values they set the fields to when used: Integer Detect Malicious Requests Intrusion Handling Warnings Checkbox 0 Disabled N/A N/A 1 Enabled Drop Connection Unchecked 2 Enabled Send Reject Unchecked 3 Enabled Send Reject Unchecked 4 Enabled Drop Connection Checked 5 Enabled Drop Connection Checked 6 Enabled Send Reject Checked 7 Enabled Send Reject Checked Int16 ExtraHdrKey Specifies the key for the extra header to be inserted into every request sent to the Real Servers. String ExtraHdrValue Specifies the value for the extra header to be inserted into every request sent to the Real Servers. String AllowedHosts This parameter is only relevant when ESP is enabled. Specifies all the virtual hosts that can be accessed via this Virtual Service. String AllowedDirectories This parameter is only relevant when ESP is enabled. Specifies all the virtual directories that can be accessed via this Virtual Service. String AllowedGroups Specifies the groups that are allowed to access this Virtual Service. String GroupSIDs Specify the group security identifier (SIDs) that are allowed to access this Virtual Service. Each group must be separated by a semicolon. String SteeringGroups Enter the Active Directory group names that will be used for steering traffic. Use a semi-colon to separate multiple group names. The steering group index number corresponds to the location of the group in this list. String IncludeNestedGroups Specify if nested groups should be included in the authentication attempt. Boolean DisplayPubPriv Display the public/private option on the login page. Based on the option the user selects on the login form, the session timeout value will be set to the value specified for either the public or private timeout. Boolean DisablePasswordForm Enabling this option removes the password field from the login page. This may be needed when password validation is not required, for example if using RSA SecurID authentication in a singular fashion. Boolean Domain Specifies the Single Sign On (SSO) domain in which this Virtual Service will operate. String AltDomains Specifies alternative domains to be assigned to a Virtual Service when configuring multi-domain authentication. To specify multiple alternative domains use a space-separated list. String Logoff This parameter is only relevant when ESP is enabled and when the Client Authentication Mode is set to Form Based. Specify the string that the LoadMaster should use to detect a logout event. Multiple logoff strings can be specified by using a space-separated list. If the URL to be matched contains sub-directories before the specified string, the Logoff String will not be matched. Therefore the LoadMaster will not log the user off. String ESPLogs Enable ESP logging. Valid values are below: 0 - Logging off 1 - User Access 2 - Security 3 - User Access and Security 4 - Connection 5 - User Access and Connection 6 - Security and connection 7 - User Access, Security and Connection Note: The only valid values for SMTP services are 0 and 4. For SMTP services, security issues are always logged. Nothing is logged for user access because there are no logins. Int16 SMTPAllowedDomains Specifies all the permitted domains that are allowed to be received by this Virtual Service. String ESPEnabled Specifies whether to enable or disable the Edge Security Pack (ESP) features. Boolean UserPwdChangeUrl This is relevant when using form-based or LDAP authentication. Specify the URL that users can use to change their password. If a user’s password has expired, or if they must reset their password, this URL and the UserPwdChangeMsg is displayed on the login form. This URL must be put into the exception list for authentication, if required. String UserPwdChangeMsg This parameter is only relevant if the UserPwdChangeURL parameter is set. Specify the text to be displayed on the login form when the user must reset their password. String SecurityHeaderOptions Enable this option to add the Strict-Transport-Security header to all LoadMaster-generated messages (ESP and error messages). 0 - Don't add the Strict Transport Security Header (default value) 1 - Add the Strict Transport Security Header - no subdomains 2 - Add the Strict Transport Security Header - include subdomains Enable this option to add the Strict-Transport-Security header to all LoadMaster-generated messages (ESP and error messages). Int16 InputAuthMode Specifies the client authentication method to be used: 0 - Delegate to Server 1 - Basic Authentication 2 - Form Based 4 - Client Certificate 5 - NTLM 6 - SAML Int16 OutConf String OutputAuthMode Specifies the server authentication mode to be used: 0 - None 1 - Basic Authentication 2 - Form Based 2 - KCD Int16 StartTLSMode 0 - HTTP/HTTPS (the Service Type needs to be set to HTTP/HTTPS for this to work) The Virtual Service Type must be set to STARTTLS for the remaining values to be set: 1 - SMTP (STARTTLS if requested) 2 - SMTP (STARTTLS always) 3 - FTP 4 - IMAP 6 - POP3 Int16 ExtraPorts Specifies extra ports that the Virtual Service will listen to. String AltAddress Specifies the alternate address for this Virtual Service. String MultiConnect Enabling this option permits the LoadMaster to manage connection handling between the LoadMaster and the Real Servers. Requests from multiple clients will be sent over the same TCP connection. Multiplexing only works for simple HTTP GET operations. This parameter cannot be enabled in certain situations, for example if WAF, ESP or SSL Acceleration is enabled. Boolean SingleSignOnDir This parameter relates to the SSO Image Set drop-down in the ESP Options section of the modify Virtual Service screen. Specify the name of the image set to be used for the login screen. If no image set is specified, the default Exchange image set will be used. String OCSPVerify Specifies whether to verify (via Online Certificate Status Protocol (OCSP)) that the client certificate is valid. String FollowVSID Specifies the ID of the Virtual Service to follow. Int32 TlsType Specify which of the following protocols to support; SSLv3, TLS1.0, TLS1.1 or TLS1.2. By default, TLS1.1 and TLS1.2 are enabled. The protocols can be enabled and disabled using a bitmask value. Refer to the table below to find out what number corresponds to which settings. Number | SSLv3 | TLS1.0 | TLS1.1 | TLS1.2 0 | Enabled | Enabled | Enabled | Enabled 1 | Disabled | Enabled | Enabled | Enabled 2 | Enabled | Disabled | Enabled | Enabled 3 | Disabled | Disabled | Enabled | Enabled 4 | Enabled | Enabled | Disabled | Enabled 5 | Disabled | Enabled | Disabled | Enabled 6 | Enabled | Disabled | Disabled | Enabled 7 | Disabled | Disabled | Disabled | Enabled 8 | Enabled | Enabled | Enabled | Disabled 9 | Disabled | Enabled | Enabled | Disabled 10 | Enabled | Disabled | Enabled | Disabled 11 | Disabled | Disabled | Enabled | Disabled 12 | Enabled | Enabled | Disabled | Disabled 13 | Disabled | Enabled | Disabled | Disabled 14 | Enabled | Disabled | Disabled | Disabled Int32 CheckPostData This parameter is only relevant if the HTTP Method is set to POST. When using the POST method, up to 2047 characters of POST data can be sent to the server. String CheckCodes A space-separated list of HTTP status codes that should be treated as successful when received from the Real Server. Range: 300-599 String PreProcPrecedence This parameter should be used in conjunction with PreProcPrecedencePos. This parameter is used to specify the name of the existing rule whose position you wish to change. This parameter relates to Content Matching Rules only. String PreProcPrecedencePos This parameter, in conjunction with the PreProcPrecedence parameter, is used to change the position of the rule in a sequence of rules. For example a position of 2 means the rule will be checked second. This parameter relates to the Content Matching Rules only. Int16 RequestPrecedence This parameter should be used in conjunction with RequestPrecedencePos. This parameter is used to specify the name of the existing request rule whose position you wish to change. This parameter relates to the following rule types: Content Matching Add Header Delete Header Replace Header Modify URL String RequestPrecedencePos This parameter, in conjunction with the RequestPrecedence parameter, is used to change the position of the rule in a sequence of rules. For example a position of 2 means the rule will be checked second. Int16 ResponsePrecedence This parameter should be used in conjunction with ResponsePrecedencePos. This parameter is used to specify the name of the existing response rule whose position you wish to change. This parameter relates to the following rule types: Content Matching Add Header Delete Header Replace Header String ResponsePrecedencePos This parameter, in conjunction with the ResponsePrecedence parameter, is used to change the position of the rule in a sequence of rules. For example, a position of 2 means the rule will be checked second. Int16 RsRulePrecedence This parameter should be used in conjunction with RSRulePrecedencePos. This parameter is used to specify the name of the existing rule whose position you wish to change. String RsRulePrecedencePos This parameter, in conjunction with the RSRulePrecedence parameter, is used to change the position of the rule in a sequence of rules. For example, a position of 2 means the rule will be checked second. Int16 NeedHostName When this parameter is enabled, the hostname is always required to be sent in the TLS client hello message. If it is not sent, the connection is dropped. Valid values: 0 - Disabled 1 - Enabled Boolean CopyHdrFrom This is the name of the source header field to copy into the new header field before the request is sent to the Real Servers. String CopyHdrTo This parameter is used in conjunction with the CopyHdrFrom parameter. The name of the header field into which the source header is to be copied. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String VirtualService The IP address for the Virtual Service. String String VSPort The port of the new Virtual Service. Int32 Int32 VSProtocol The protocol of the new Virtual Service. String String AddVia Specifies which headers are added to the HTTP stream. Choose the number of the option to use. 0 - Legacy Operation(XXX) 1 - None 2 - X-Forwarded-For 3 - X-Forwarded-For (No Via) 4 - X-ClientSide 5 - X-ClientSide (No Via) 6 - Via Only Int16 Int16 Template Specifies a template name. String String Cache Enables or disables caching on this Virtual Service. Boolean Boolean CertFile Specifies the name of the certificate file to use that is already installed on the load balancer. Note: This will NOT upload a certificate file to the load balancer. String String CheckType Specifies the protocol to use to check if the service is up. Valid options are "tcp", "icmp", "https", "http", "smtp", "nntp", "ftp", "telnet", "pop3", "imap", "rdp", or "none". String String CheckHost The address to use to check if the service is up. String String CheckPattern A regular expression string that can be validate on a 200 reply to determine if the service is up. String String CheckUrl The URL to check if the service is up. The maximum character length for the CheckUrl parameter value is 126 characters. String String CheckHeaders Specify up to four additional headers/fields which will be sent with each health check request. Separate the pairs with a pipe, for example; Host:xyc|UserAgent:prq. String String LdapEndpoint Specify the name of an LDAP endpoint to use for the health checks. If LDAP is selected as the CheckType, the server IP address (or addresses) and ports from the LDAP endpoint configuration are used instead of the Real Server IP address and port. String String MatchLen This parameter is only relevant when the CheckType is set to "bdata". Specify the number of bytes to find the CheckPattern within. String String CheckUse1_1 Specifies that the health checker use HTTP/1.1 instead of HTTP/1.0. 0 - HTTP/1.0 1 - HTTP/1.1 Int32 Int32 CheckPort The port to use to check if the service is up. Int32 Int32 EnhancedHealthChecks Enables or disables Enhanced Health Check Options for the Virtual Service. Boolean Boolean RsMinimum Specifies the minimum number of Real Servers that are required to be active for the Virtual Service to be considered up. Int32 Int32 ClientCert Specify how client certificates should be used. Valid values are 0, 1, or 2. Zero indicates that client certificates are not use. One indicates that client certificates are required. Two indicates that client certificates are required and additional HEAD information is being sent. Int16 Int16 Compress Enable or disable file compression for the Virtual Service. Boolean Boolean Cookie Specifies a cookie name. This parameter is only relevant when the persistence mode is set to "cookie", "active-cookie", "cookie-src" or "active-cook-src". String String CachePercent Specifies the maximum cache usage for this Virtual Service. Note: Setting two Virtual Services using 50% of cache will use 100% of all cache storage. This parameter accepts values from 0 to 100. Int16 Int16 DefaultGW Specifies a Virtual Service-specific default gateway to be used to send responses back to clients. If not set, the global default gateway will be used. String String Enable Enables or disables the Virtual Service. Boolean Boolean ErrorCode If no Real Servers are available, the LoadMaster can terminate the connection with an HTTP error code. Specify the error code number in this parameter. String String ErrorUrl When no Real Servers are available and an error response is sent back to the client, a redirect URL can also be specified. String String PortFollow This parameter was depreciated as of 7.1-24. For LoadMasters with version 7.1-24 or higher, use the FollowVSID parameter to set port following. Int32 Int32 ForceL7 Enabling ForceL7 means the Virtual Service runs at Layer 7 and not Layer 4. This may be needed for various reasons, including that only Layer 7 services can be non-transparent. Boolean Boolean Idletime Specifies the length of time (in seconds) that a connection may remain idle before it is closed. The range for this parameter is 0 to 86400. There are some special values that can be set for this parameter: - 0: Ensures the default L7 connection timeout is used. The default timeout value can be modified by setting the conntimeout parameter. - 1: Discards the connection after the packet is first forwarded – a response is not expected or handled. - 2: Uses a DNS-type of operation. The connection is dropped after the reply message. Setting it to 1 or 2 enables better performance and memory usage for UDP connections and they correspond better to how UDP is used. Int32 Int32 LocalBindAddresses Specifies a space separated list of IP addresses. This corresponds to the Alternate Source Address in the Advanced Properties section of the WUI. Allow connections scaling over 64K Connections needs to be enabled in L7 Configuration for this feature to work. String[] String[] VSType Specifies the type of service being load balanced: gen - Generic http - HTTP/HTTPS ts - Remote Terminal tls – STARTTLS protocols log – Log Insight String String Nickname Specifies the "friendly" name of the service. In addition to the usual alphanumeric characters, the following "special" characters can be used as part of the Service Name: . @ - _ However, there must be at least one alphanumeric character before the special characters. String String Persist Specifies the type of persistence (stickiness) to be used for this Virtual Service. The following persistence values are supported: ssl, cookie, active-cookie, cookie-src, active-cook-src, cookie-hash, cookie-hash-src, url, query-hash, host, header, super, super-src, src, rdp, rdp-src, rdp-sb, rdp-sb-src and udpsip. Note: If setting the persistence mode to an option that requires a cookie (or query-hash), the cookie parameter must also be set. String String PersistTimeout The length of time (in seconds) after the last connection that the LoadMaster will remember the persistence information. Timeout values are rounded down to an even number of minutes. Setting a value that is not a number of whole minutes results in the excess being ignored. Setting a value to less than 60 seconds results in a value of 0 being set, which disables persistency. Int32 Int32 QueryTag This is the query tag to be matched if the Persist type is set to query-hash. String String CipherSet Specifies a cipher set name. String String SSLReencrypt This parameter is only relevant if SSL Acceleration is enabled. When this option is enabled, the SSL data stream is re-encrypted before sending to the Real Server. Boolean Boolean SSLReverse Enabling this parameter means that the data from the LoadMaster to the Real Server is re-encrypted. Boolean Boolean SSLRewrite When the Real Server rejects a request with an HTTP redirect, the requesting Location URL may need to be converted to specify HTTPS instead of HTTP (and vice versa). String String ReverseSNIHostname If this option is enabled, the host name is required to be sent in the TLS client hello message. If it is not sent the connection will be dropped. String String Schedule Specifies the type of scheduling of new connections to Real Servers that is to be performed. The following values are supported: rr = round robin wrr = weighted round robin lc = least connection wlc = weighted least connection fixed = fixed weighting adaptive = resource based (adaptive) sh = source IP hash dl = weighted response time sdn-adaptive = resource based (SDN adaptive) String String ServerInit Specifies one of the following values: 0 = Normal Protocols 1 = SMTP 2 = SSH 3 = Other Server Initiating 4 = IMAP4 5 = MySQL 6 = POP3 Int16 Int16 SSLAcceleration Specifies whether to enable SSL handling on the Virtual Service. Boolean Boolean StandByAddr Specifies the IP address of the "Sorry" server that is to be used when no other Real Servers are available. This server will not be health checked and is assumed to be always available. String String StandByPort Specifies the port of the "Sorry" server. String String TransactionLimit This is a legacy parameter that should no longer be used. It was used previously when the SSL proxy was limited to 6K total connections. The transaction limit was used to limit one Virtual Service to only handle so many connections out of this 6K. On newer systems, where the limit is greater than 64K - this feature is no longer required. Int32 Int32 Transparent When using Layer 7, when this is enabled - the connection arriving at the Real Server appears to come directly from the client. Alternatively, the connection can be non-transparent, which means that the connections at the Real Server appear to come from the LoadMaster. 0 - Disabled 1 - Enabled If a Virtual Service (with or without a SubVS) has SSL re-encrypt enabled, the transparency flag of the Virtual Service has no meaning (re-encryption forces transparency to be off). The transparency setting can still be modified by the API, and is honored when re-encrypt is disabled on the Virtual Service. Boolean Boolean SubnetOriginating When transparency is not enabled, the source IP address of connections to the Real Servers is that of the Virtual Service. When transparency is enabled, the source IP address will be the IP address that is initiating connection to the Virtual Service. If the Real Server is on a subnet, and the Subnet Originating Requests option is enabled, then the subnet address of the LoadMaster will be used as the source IP address. Boolean Boolean UseforSnat By default, when the LoadMaster is being used to NAT Real Servers, the source IP address used on the Internet is that of the LoadMaster. Enabling this option allows the Real Servers configured to use the Virtual Service as the source IP address instead. If the Real Servers are configured on more than one Virtual Service which has this option set, only connections to destination port 80 will use this Virtual Service as the source IP address. Boolean Boolean QoS Specifies the Quality of Service. The following values are supported: 0 - Normal-Service 1 - Minimize-Cost 2 - Maximize-Reliability 4 - Maximize-Throughput 8 - Minimize-Delay String String CheckUseGet When accessing the health check URL - the system can use the HEAD, the GET or the POST method: 0 - HEAD 1 - GET 2 - POST Int32 Int32 Verify Specifies a verification bitmask. The valid values of the Verify parameter are as follows: Bit 0: set this to 1 to enable detection intrusion. Note: Bit 0 needs to be set to 1 in order to use the other two bits. Bit 1: Determines whether to reject or drop a connection. Setting it to 1 will drop the connection. Bit 2: Determines whether to give just warnings on bad requests or also on malicious (but not invalid) requests. The following table lists the valid integers and the values they set the fields to when used: Integer Detect Malicious Requests Intrusion Handling Warnings Checkbox 0 Disabled N/A N/A 1 Enabled Drop Connection Unchecked 2 Enabled Send Reject Unchecked 3 Enabled Send Reject Unchecked 4 Enabled Drop Connection Checked 5 Enabled Drop Connection Checked 6 Enabled Send Reject Checked 7 Enabled Send Reject Checked Int16 Int16 ExtraHdrKey Specifies the key for the extra header to be inserted into every request sent to the Real Servers. String String ExtraHdrValue Specifies the value for the extra header to be inserted into every request sent to the Real Servers. String String AllowedHosts This parameter is only relevant when ESP is enabled. Specifies all the virtual hosts that can be accessed via this Virtual Service. String String AllowedDirectories This parameter is only relevant when ESP is enabled. Specifies all the virtual directories that can be accessed via this Virtual Service. String String AllowedGroups Specifies the groups that are allowed to access this Virtual Service. String String GroupSIDs Specify the group security identifier (SIDs) that are allowed to access this Virtual Service. Each group must be separated by a semicolon. String String SteeringGroups Enter the Active Directory group names that will be used for steering traffic. Use a semi-colon to separate multiple group names. The steering group index number corresponds to the location of the group in this list. String String IncludeNestedGroups Specify if nested groups should be included in the authentication attempt. Boolean Boolean DisplayPubPriv Display the public/private option on the login page. Based on the option the user selects on the login form, the session timeout value will be set to the value specified for either the public or private timeout. Boolean Boolean DisablePasswordForm Enabling this option removes the password field from the login page. This may be needed when password validation is not required, for example if using RSA SecurID authentication in a singular fashion. Boolean Boolean Domain Specifies the Single Sign On (SSO) domain in which this Virtual Service will operate. String String AltDomains Specifies alternative domains to be assigned to a Virtual Service when configuring multi-domain authentication. To specify multiple alternative domains use a space-separated list. String String Logoff This parameter is only relevant when ESP is enabled and when the Client Authentication Mode is set to Form Based. Specify the string that the LoadMaster should use to detect a logout event. Multiple logoff strings can be specified by using a space-separated list. If the URL to be matched contains sub-directories before the specified string, the Logoff String will not be matched. Therefore the LoadMaster will not log the user off. String String ESPLogs Enable ESP logging. Valid values are below: 0 - Logging off 1 - User Access 2 - Security 3 - User Access and Security 4 - Connection 5 - User Access and Connection 6 - Security and connection 7 - User Access, Security and Connection Note: The only valid values for SMTP services are 0 and 4. For SMTP services, security issues are always logged. Nothing is logged for user access because there are no logins. Int16 Int16 SMTPAllowedDomains Specifies all the permitted domains that are allowed to be received by this Virtual Service. String String ESPEnabled Specifies whether to enable or disable the Edge Security Pack (ESP) features. Boolean Boolean UserPwdChangeUrl This is relevant when using form-based or LDAP authentication. Specify the URL that users can use to change their password. If a user’s password has expired, or if they must reset their password, this URL and the UserPwdChangeMsg is displayed on the login form. This URL must be put into the exception list for authentication, if required. String String UserPwdChangeMsg This parameter is only relevant if the UserPwdChangeURL parameter is set. Specify the text to be displayed on the login form when the user must reset their password. String String SecurityHeaderOptions Enable this option to add the Strict-Transport-Security header to all LoadMaster-generated messages (ESP and error messages). 0 - Don't add the Strict Transport Security Header (default value) 1 - Add the Strict Transport Security Header - no subdomains 2 - Add the Strict Transport Security Header - include subdomains Enable this option to add the Strict-Transport-Security header to all LoadMaster-generated messages (ESP and error messages). Int16 Int16 InputAuthMode Specifies the client authentication method to be used: 0 - Delegate to Server 1 - Basic Authentication 2 - Form Based 4 - Client Certificate 5 - NTLM 6 - SAML Int16 Int16 OutConf String String OutputAuthMode Specifies the server authentication mode to be used: 0 - None 1 - Basic Authentication 2 - Form Based 2 - KCD Int16 Int16 StartTLSMode 0 - HTTP/HTTPS (the Service Type needs to be set to HTTP/HTTPS for this to work) The Virtual Service Type must be set to STARTTLS for the remaining values to be set: 1 - SMTP (STARTTLS if requested) 2 - SMTP (STARTTLS always) 3 - FTP 4 - IMAP 6 - POP3 Int16 Int16 ExtraPorts Specifies extra ports that the Virtual Service will listen to. String String AltAddress Specifies the alternate address for this Virtual Service. String String MultiConnect Enabling this option permits the LoadMaster to manage connection handling between the LoadMaster and the Real Servers. Requests from multiple clients will be sent over the same TCP connection. Multiplexing only works for simple HTTP GET operations. This parameter cannot be enabled in certain situations, for example if WAF, ESP or SSL Acceleration is enabled. Boolean Boolean SingleSignOnDir This parameter relates to the SSO Image Set drop-down in the ESP Options section of the modify Virtual Service screen. Specify the name of the image set to be used for the login screen. If no image set is specified, the default Exchange image set will be used. String String OCSPVerify Specifies whether to verify (via Online Certificate Status Protocol (OCSP)) that the client certificate is valid. String String FollowVSID Specifies the ID of the Virtual Service to follow. Int32 Int32 TlsType Specify which of the following protocols to support; SSLv3, TLS1.0, TLS1.1 or TLS1.2. By default, TLS1.1 and TLS1.2 are enabled. The protocols can be enabled and disabled using a bitmask value. Refer to the table below to find out what number corresponds to which settings. Number | SSLv3 | TLS1.0 | TLS1.1 | TLS1.2 0 | Enabled | Enabled | Enabled | Enabled 1 | Disabled | Enabled | Enabled | Enabled 2 | Enabled | Disabled | Enabled | Enabled 3 | Disabled | Disabled | Enabled | Enabled 4 | Enabled | Enabled | Disabled | Enabled 5 | Disabled | Enabled | Disabled | Enabled 6 | Enabled | Disabled | Disabled | Enabled 7 | Disabled | Disabled | Disabled | Enabled 8 | Enabled | Enabled | Enabled | Disabled 9 | Disabled | Enabled | Enabled | Disabled 10 | Enabled | Disabled | Enabled | Disabled 11 | Disabled | Disabled | Enabled | Disabled 12 | Enabled | Enabled | Disabled | Disabled 13 | Disabled | Enabled | Disabled | Disabled 14 | Enabled | Disabled | Disabled | Disabled Int32 Int32 CheckPostData This parameter is only relevant if the HTTP Method is set to POST. When using the POST method, up to 2047 characters of POST data can be sent to the server. String String CheckCodes A space-separated list of HTTP status codes that should be treated as successful when received from the Real Server. Range: 300-599 String String PreProcPrecedence This parameter should be used in conjunction with PreProcPrecedencePos. This parameter is used to specify the name of the existing rule whose position you wish to change. This parameter relates to Content Matching Rules only. String String PreProcPrecedencePos This parameter, in conjunction with the PreProcPrecedence parameter, is used to change the position of the rule in a sequence of rules. For example a position of 2 means the rule will be checked second. This parameter relates to the Content Matching Rules only. Int16 Int16 RequestPrecedence This parameter should be used in conjunction with RequestPrecedencePos. This parameter is used to specify the name of the existing request rule whose position you wish to change. This parameter relates to the following rule types: Content Matching Add Header Delete Header Replace Header Modify URL String String RequestPrecedencePos This parameter, in conjunction with the RequestPrecedence parameter, is used to change the position of the rule in a sequence of rules. For example a position of 2 means the rule will be checked second. Int16 Int16 ResponsePrecedence This parameter should be used in conjunction with ResponsePrecedencePos. This parameter is used to specify the name of the existing response rule whose position you wish to change. This parameter relates to the following rule types: Content Matching Add Header Delete Header Replace Header String String ResponsePrecedencePos This parameter, in conjunction with the ResponsePrecedence parameter, is used to change the position of the rule in a sequence of rules. For example, a position of 2 means the rule will be checked second. Int16 Int16 RsRulePrecedence This parameter should be used in conjunction with RSRulePrecedencePos. This parameter is used to specify the name of the existing rule whose position you wish to change. String String RsRulePrecedencePos This parameter, in conjunction with the RSRulePrecedence parameter, is used to change the position of the rule in a sequence of rules. For example, a position of 2 means the rule will be checked second. Int16 Int16 NeedHostName When this parameter is enabled, the hostname is always required to be sent in the TLS client hello message. If it is not sent, the connection is dropped. Valid values: 0 - Disabled 1 - Enabled Boolean Boolean CopyHdrFrom This is the name of the source header field to copy into the new header field before the request is sent to the Real Servers. String String CopyHdrTo This parameter is used in conjunction with the CopyHdrFrom parameter. The name of the header field into which the source header is to be copied. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String Port The port that the Virtual Service is listening on. int32 int32 Protocol Specify if the service is using TCP or UDP protocols. string string DisplayPasswordForm Enabling this option removes the password field from the login page. This may be needed when password validation is not required, for example if using RSA SecurID authentication in a singular fashion. boolean boolean -------------------------- Example -------------------------- PS C:\> New-AdcVirtualService -Port 80 -Protocol tcp -VirtualService 10.154.11.234 Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. New-AdcVirtualServiceResponseBodyRule New AdcVirtualServiceResponseBodyRule New-AdcVirtualServiceResponseBodyRule VSIndex Int32 RuleName String LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String New-AdcVirtualServiceResponseBodyRule VSIndex Int32 RuleName String LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String VSIndex Int32 Int32 RuleName String String LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String New-AdcVirtualServiceRule Add a content rule to a Virtual Service. New AdcVirtualServiceRule Add the specified content rule to a Virtual Service. New-AdcVirtualServiceRule VirtualService The IP address of the Virtual Service to add the content rule to. String VSPort The port of the Virtual Service to add the content rule to. Int32 VSProtocol The port of the Virtual Service to add the content rule to. String VSIndex The index number of the Virtual Service to add the content rule to. Int32 RuleType The type of content rule to add to the Virtual Service. String RuleName The name of the content rule to add to the Virtual Service. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String New-AdcVirtualServiceRule VirtualService The IP address of the Virtual Service to add the content rule to. String VSPort The port of the Virtual Service to add the content rule to. Int32 VSProtocol The port of the Virtual Service to add the content rule to. String VSIndex The index number of the Virtual Service to add the content rule to. Int32 RuleType The type of content rule to add to the Virtual Service. String RuleName The name of the content rule to add to the Virtual Service. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String VirtualService The IP address of the Virtual Service to add the content rule to. String String VSPort The port of the Virtual Service to add the content rule to. Int32 Int32 VSProtocol The port of the Virtual Service to add the content rule to. String String VSIndex The index number of the Virtual Service to add the content rule to. Int32 Int32 RuleType The type of content rule to add to the Virtual Service. String String RuleName The name of the content rule to add to the Virtual Service. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> New-AdcVirtualServiceRule -RuleName ActiveSync_1041 -RuleType request -VirtualService 10.154.11.181 -VSPort 443 -VSProtocol tcp Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. New-AdcVsWafRule Assigns Web Application Firewall (WAF) rules to the specified Virtual Service. New AdcVsWafRule Add the specified WAF rule to the specified Virtual Service. New-AdcVsWafRule VS The IP address of the relevant Virtual Service. String VSPort Specifies the port on which this Virtual Service accepts connections. String VSProtocol Specifies the communication protocol of the Virtual Service. Valid options are TCP or UDP (not case sensitive). String Rule Specify the name of the rule to be assigned. The rule name must be preceded with a letter/word and a forward slash. The letter used depends on the type of rule being added: - C or Custom - Z or ApplicationGeneric - A or ApplicationSpecific - G or Generic String Enablerules Specific rules can be enabled per ruleset by specifying the rule IDs to be enabled. Multiple rules can be enabled by using a comma-separated list. To retrieve the rule IDs, run the Get-WAFVSRules command. To only update rules (and not rulesets), run the New-AdcWafRule command with a blank Rule parameter. To enable all rules, run the New-AdcWafRule command with blank rule and disablerules parameters. String Disablerules Specific rules can be disabled per ruleset by specifying the rule IDs to be disabled. Multiple rules can be disabled by using a comma-separated list. To retrieve the rule IDs, run the Get-WAFVSRules command. To only update rules (and not rulesets), run the Add-AdcWafRule command with a blank Rule parameter. To remove all disabled rules (i.e. enable all rules), run the Add-AdcWafRule command with blank rule and disablerules parameters. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String New-AdcVsWafRule VS The IP address of the relevant Virtual Service. String VSPort Specifies the port on which this Virtual Service accepts connections. String VSProtocol Specifies the communication protocol of the Virtual Service. Valid options are TCP or UDP (not case sensitive). String Rule Specify the name of the rule to be assigned. The rule name must be preceded with a letter/word and a forward slash. The letter used depends on the type of rule being added: - C or Custom - Z or ApplicationGeneric - A or ApplicationSpecific - G or Generic String Enablerules Specific rules can be enabled per ruleset by specifying the rule IDs to be enabled. Multiple rules can be enabled by using a comma-separated list. To retrieve the rule IDs, run the Get-WAFVSRules command. To only update rules (and not rulesets), run the New-AdcWafRule command with a blank Rule parameter. To enable all rules, run the New-AdcWafRule command with blank rule and disablerules parameters. String Disablerules Specific rules can be disabled per ruleset by specifying the rule IDs to be disabled. Multiple rules can be disabled by using a comma-separated list. To retrieve the rule IDs, run the Get-WAFVSRules command. To only update rules (and not rulesets), run the Add-AdcWafRule command with a blank Rule parameter. To remove all disabled rules (i.e. enable all rules), run the Add-AdcWafRule command with blank rule and disablerules parameters. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String VS The IP address of the relevant Virtual Service. String String VSPort Specifies the port on which this Virtual Service accepts connections. String String VSProtocol Specifies the communication protocol of the Virtual Service. Valid options are TCP or UDP (not case sensitive). String String Rule Specify the name of the rule to be assigned. The rule name must be preceded with a letter/word and a forward slash. The letter used depends on the type of rule being added: - C or Custom - Z or ApplicationGeneric - A or ApplicationSpecific - G or Generic String String Enablerules Specific rules can be enabled per ruleset by specifying the rule IDs to be enabled. Multiple rules can be enabled by using a comma-separated list. To retrieve the rule IDs, run the Get-WAFVSRules command. To only update rules (and not rulesets), run the New-AdcWafRule command with a blank Rule parameter. To enable all rules, run the New-AdcWafRule command with blank rule and disablerules parameters. String String Disablerules Specific rules can be disabled per ruleset by specifying the rule IDs to be disabled. Multiple rules can be disabled by using a comma-separated list. To retrieve the rule IDs, run the Get-WAFVSRules command. To only update rules (and not rulesets), run the Add-AdcWafRule command with a blank Rule parameter. To remove all disabled rules (i.e. enable all rules), run the Add-AdcWafRule command with blank rule and disablerules parameters. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> New-AdcVsWafRule -Rule G/ip_reputation -VS 10.35.47.86 -VSPort 80 -VSProtocol tcp Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed; Data=} Return Code..: 200 Response.....: Command successfully executed New-Certificate WARNING: This function is deprecated. Use the following command instead: New-TlsCertificate New Certificate WARNING: This function is deprecated. Use the following command instead: New-TlsCertificate New-Certificate Name String Password String Replace SwitchParameter Path String LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String New-Certificate Name String Password String Replace SwitchParameter Path String LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String Name String String Password String String Replace SwitchParameter SwitchParameter Path String String LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String New-Cluster Converts the LoadMaster to cluster mode. New Cluster Converts the LoadMaster to cluster mode. New-Cluster SharedAddress The initial shared IP address of the cluster. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String New-Cluster SharedAddress The initial shared IP address of the cluster. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String SharedAddress The initial shared IP address of the cluster. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> New-Cluster -SharedAddress 10.11.0.31 Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. New-ClusterNode Adds a LoadMaster to a cluster. New ClusterNode Adds a single node LoadMaster (which is available to be added) to the cluster. Before running this command, run the Join-Cluster command on the LoadMaster node to be added to the cluster in a different console window. This makes the node LoadMaster available to be added. To finish adding the node, then run the New-ClusterNode command on the shared IP address immediately after running the Join-Cluster command in a different console window. New-ClusterNode Address The IP address of the node LoadMaster. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String New-ClusterNode Address The IP address of the node LoadMaster. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String Address The IP address of the node LoadMaster. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> New-ClusterNode -Address 10.35.47.15 -LoadBalancer -10.35.47.100 -Credential bal Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. New-GeoCluster Add a new GEO cluster. New GeoCluster Run this command to add a new GEO cluster to the LoadMaster. New-GeoCluster ClusterIp The IP address of the GEO cluster. String ClusterName The name of the GEO cluster. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String New-GeoCluster ClusterIp The IP address of the GEO cluster. String ClusterName The name of the GEO cluster. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String ClusterIp The IP address of the GEO cluster. String String ClusterName The name of the GEO cluster. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> New-GeoCluster -ClusterIp 10.34.52.56 -ClusterName ExampleCluster2 Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. New-GeoCustomLocation Add a new custom location. New GeoCustomLocation Creates a custom GEO location which can be selected when using the Location Based selection criteria. New-GeoCustomLocation Location The name of the custom location. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String New-GeoCustomLocation Location The name of the custom location. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String Location The name of the custom location. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> New-GeoCustomLocation -Location "New York" Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. New-GeoDNSSECKeySigningKey Generate the Key Signing Key (KSK). New GeoDNSSECKeySigningKey Generate the KSK. New-GeoDNSSECKeySigningKey SigningAlgorithm Specify the cryptographic algorithm to use. If this parameter is omitted, the default value is used. Valid values are: RSASHA256 NSEC3RSASHA1 NSEC3RSASHA1 The default value is RSASHA256. String SigningKeySize Specify the key size (in bits). If this parameter is omitted, the default value is used. Valid values are: 1024 2048 4096 The default value is 2048. Int32 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String New-GeoDNSSECKeySigningKey SigningAlgorithm Specify the cryptographic algorithm to use. If this parameter is omitted, the default value is used. Valid values are: RSASHA256 NSEC3RSASHA1 NSEC3RSASHA1 The default value is RSASHA256. String SigningKeySize Specify the key size (in bits). If this parameter is omitted, the default value is used. Valid values are: 1024 2048 4096 The default value is 2048. Int32 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String SigningAlgorithm Specify the cryptographic algorithm to use. If this parameter is omitted, the default value is used. Valid values are: RSASHA256 NSEC3RSASHA1 NSEC3RSASHA1 The default value is RSASHA256. String String SigningKeySize Specify the key size (in bits). If this parameter is omitted, the default value is used. Valid values are: 1024 2048 4096 The default value is 2048. Int32 Int32 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> New-GeoDNSSECKeySigningKey -SigningAlgorithm RSASHA512 -SigningKeySize 2048 Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. New-GeoFQDN Add an FQDN. New GeoFQDN Add a new GEO FQDN. New-GeoFQDN FQDN The name of the FQDN. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String New-GeoFQDN FQDN The name of the FQDN. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String FQDN The name of the FQDN. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> New-GeoFQDN -FQDN ExampleFQDN.com Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed. Added FQDN ExampleFQDN.com; Data=} Return Code..: 200 Response.....: Command successfully executed. Added FQDN ExampleFQDN.com New-GeoFQDNSiteAddress Add an IP address to an FQDN. New GeoFQDNSiteAddress Run this command to add the specified IP address to the relevant GEO FQDN. New-GeoFQDNSiteAddress FQDN The name of the FQDN. String SiteAddress The address to be added to the FQDN. String Cluster If needed, enter the cluster name where the IP address is located. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String New-GeoFQDNSiteAddress FQDN The name of the FQDN. String SiteAddress The address to be added to the FQDN. String Cluster If needed, enter the cluster name where the IP address is located. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String FQDN The name of the FQDN. String String SiteAddress The address to be added to the FQDN. String String Cluster If needed, enter the cluster name where the IP address is located. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> New-GeoFQDNSiteAddress -FQDN Example.com -SiteAddress 10.134.33.2 Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed. Added site 10.134.33.3 to FQDN Example.com; Data=} Return Code..: 200 Response.....: Command successfully executed. Added site 10.134.33.3 to FQDN Example.com New-GeoIpRange Add an IP address to the IP range selection criteria list. New GeoIpRange Add an IP address to the IP range selection criteria list. New-GeoIpRange IP String IP address of the IP range. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String New-GeoIpRange IP String IP address of the IP range. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String IP String IP address of the IP range. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> New-GeoIpRange -IP 10.145.32.4 Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed. IP range added; Data=} Return Code..: 200 Response.....: Command successfully executed. IP range added New-GeoIPWhitelist Add an IP address or network to the whitelist. New GeoIPWhitelist Run this command to add an IP address or network to the user-defined whitelist. The whitelist entries override the blacklist. New-GeoIPWhitelist Addr The address or network to be added to the GEO Access Control whitelist. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String New-GeoIPWhitelist Addr The address or network to be added to the GEO Access Control whitelist. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String Addr The address or network to be added to the GEO Access Control whitelist. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> New-GeoIPWhitelist -Addr 10.145.33.22 Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed. 10.145.33.22 was successfully added to GEO ACL white list.; Data=} Return Code..: 200 Response.....: Command successfully executed. 10.145.33.22 was successfully added to GEO ACL white list. New-GlobalPacketFilterACL Adds an address to the global black or white list. New GlobalPacketFilterACL Adds a host or network IP address to the global black or white Access Control List (ACL). Note that black and white lists are only enabled when packet filtering is enabled. New-GlobalPacketFilterACL Type Specifies the access control list type: black or white. String Address Specifies a host or network IP address to add to the access control list. The address can be specified in CIDR format. If the CIDR is not specified, the system uses a default of /32. String Comment Optionally add a comment about the entry. This parameter accepts a maximum of 127 characters. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String New-GlobalPacketFilterACL Type Specifies the access control list type: black or white. String Address Specifies a host or network IP address to add to the access control list. The address can be specified in CIDR format. If the CIDR is not specified, the system uses a default of /32. String Comment Optionally add a comment about the entry. This parameter accepts a maximum of 127 characters. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String Type Specifies the access control list type: black or white. String String Address Specifies a host or network IP address to add to the access control list. The address can be specified in CIDR format. If the CIDR is not specified, the system uses a default of /32. String String Comment Optionally add a comment about the entry. This parameter accepts a maximum of 127 characters. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> New-GlobalPacketFilterACL -Type black -Address 10.35.47.16 Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. New-HostsEntry Adds a host IP address and host FQDN. New HostsEntry Add a new address for local resolution. New-HostsEntry HostIP Specify the IP address for the entry. String HostFQDN Specify the host FQDN for the entry. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String New-HostsEntry HostIP Specify the IP address for the entry. String HostFQDN Specify the host FQDN for the entry. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String HostIP Specify the IP address for the entry. String String HostFQDN Specify the host FQDN for the entry. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> New-HostsEntry -HostFQDN example2.com -HostIP 10.154.11.38 Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. New-IntermediateCertificate WARNING: This function is deprecated. Use the following command instead: New-TlsIntermediateCertificate New IntermediateCertificate WARNING: This function is deprecated. Use the following command instead: New-TlsIntermediateCertificate New-IntermediateCertificate Name String Path String LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String New-IntermediateCertificate Name String Path String LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String Name String String Path String String LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String New-LdapEndpoint Add a new LDAP endpoint. New LdapEndpoint These LDAP endpoints may be used in three different areas: • Health checks • SSO domains • WUI authentication New-LdapEndpoint Name The desired name for the new LDAP endpoint. This name cannot contain any spaces. String Server Specify the address, or addresses, of the LDAP server to be used. You can also specify a port number, if desired. Separate multiple addresses with a space. String LdapProtocol Specify the transport protocol to use when communicating with the LDAP server. Valid values are: Unencrypted (default) StartTLS LDAPS String VInterval Specify how often to revalidate the user the with the LDAP server. Range: 10 – 86400 seconds Default: 60 Int16 ReferralCount To disable referral chasing, set this to 0. To enable referral chasing, set this to a value between 1 and 10. Referral chasing limits the number of hops. Note: Multiple hops may increase authentication latency. Int16 AdminUser Specify the username of an administrator user. The username that will be used to check the LDAP server. String AdminPass Specify the password for the specified administrator user. The password that will be used to check the LDAP server. String LoadBalancer The IP address of the KEMP LoadMaster that you are directing the command to. This can be set globally by using the Initialize-LoadBalancer command, but can be overridden on each individual command by using this parameter. String LBPort The port of the load balancer. Int32 Credential Specifies a user account that has permission to administer the load balancer. You can either enter a username for the load balancer or provide a PSCredential object, such as an object that is returned by the Get-Credential cmdlet. When you type a username, you are prompted for a password. Object InformationAction ActionPreference InformationVariable String New-LdapEndpoint Name The desired name for the new LDAP endpoint. This name cannot contain any spaces. String Server Specify the address, or addresses, of the LDAP server to be used. You can also specify a port number, if desired. Separate multiple addresses with a space. String LdapProtocol Specify the transport protocol to use when communicating with the LDAP server. Valid values are: Unencrypted (default) StartTLS LDAPS String VInterval Specify how often to revalidate the user the with the LDAP server. Range: 10 – 86400 seconds Default: 60 Int16 ReferralCount To disable referral chasing, set this to 0. To enable referral chasing, set this to a value between 1 and 10. Referral chasing limits the number of hops. Note: Multiple hops may increase authentication latency. Int16 AdminUser Specify the username of an administrator user. The username that will be used to check the LDAP server. String AdminPass Specify the password for the specified administrator user. The password that will be used to check the LDAP server. String LoadBalancer The IP address of the KEMP LoadMaster that you are directing the command to. This can be set globally by using the Initialize-LoadBalancer command, but can be overridden on each individual command by using this parameter. String LBPort The port of the load balancer. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\&lt;CurrentUser&gt;\TrustedPeople. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. String InformationAction ActionPreference InformationVariable String Name The desired name for the new LDAP endpoint. This name cannot contain any spaces. String String Server Specify the address, or addresses, of the LDAP server to be used. You can also specify a port number, if desired. Separate multiple addresses with a space. String String LdapProtocol Specify the transport protocol to use when communicating with the LDAP server. Valid values are: Unencrypted (default) StartTLS LDAPS String String VInterval Specify how often to revalidate the user the with the LDAP server. Range: 10 – 86400 seconds Default: 60 Int16 Int16 ReferralCount To disable referral chasing, set this to 0. To enable referral chasing, set this to a value between 1 and 10. Referral chasing limits the number of hops. Note: Multiple hops may increase authentication latency. Int16 Int16 AdminUser Specify the username of an administrator user. The username that will be used to check the LDAP server. String String AdminPass Specify the password for the specified administrator user. The password that will be used to check the LDAP server. String String LoadBalancer The IP address of the KEMP LoadMaster that you are directing the command to. This can be set globally by using the Initialize-LoadBalancer command, but can be overridden on each individual command by using this parameter. String String LBPort The port of the load balancer. Int32 Int32 Credential Specifies a user account that has permission to administer the load balancer. You can either enter a username for the load balancer or provide a PSCredential object, such as an object that is returned by the Get-Credential cmdlet. When you type a username, you are prompted for a password. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\&lt;CurrentUser&gt;\TrustedPeople. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. String String -------------------------- Example -------------------------- PS C:\> New-LdapEndpoint -Name Example3 -AdminPass examplePassword -AdminUser ExampleUser -LdapProtocol StartTLS -Server 10.154.22.11 Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. New-LmIPConnectionLimit Add an IP address to be limited. New LmIPConnectionLimit Specify an IP address to be limited. New-LmIPConnectionLimit L7addr Add the IP address or network to be limited. String L7limit Limit the number of connection attempts (per second) from a specific host/network. Int32 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String New-LmIPConnectionLimit L7addr Add the IP address or network to be limited. String L7limit Limit the number of connection attempts (per second) from a specific host/network. Int32 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String L7addr Add the IP address or network to be limited. String String L7limit Limit the number of connection attempts (per second) from a specific host/network. Int32 Int32 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> New-LmIpConnectionLimit -L7addr 10.134.55.23 -L7limit 100 Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. New-LmVpnConnection Creates a new Virtual Private Network (VPN) connection. New LmVpnConnection Run this command to create a new VPN connection. New-LmVpnConnection Name The name of the VPN. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String New-LmVpnConnection Name The name of the VPN. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String Name The name of the VPN. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> New-LmVpnConnection -Name ExampleVPNConnection Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. New-NetworkBondedInterface Add a standalone interface to a bonded interface. New NetworkBondedInterface The Register-NetworkBondedInterface command must be run before running this command. New-NetworkBondedInterface InterfaceID The Interface ID of the Bonded Interface. To view the interface ID for each of the interfaces, run the Get-LmNetworkInterface command. Int16 BondID The Interface ID of the interface to link to the bonded interface. Int16 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String New-NetworkBondedInterface InterfaceID The Interface ID of the Bonded Interface. To view the interface ID for each of the interfaces, run the Get-LmNetworkInterface command. Int16 BondID The Interface ID of the interface to link to the bonded interface. Int16 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String InterfaceID The Interface ID of the Bonded Interface. To view the interface ID for each of the interfaces, run the Get-LmNetworkInterface command. Int16 Int16 BondID The Interface ID of the interface to link to the bonded interface. Int16 Int16 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> New-NetworkBondedInterface -InterfaceID 1 -BondID 2 Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Data field...: @{Interface=} Id : 1 IPAddress : NBondMembers : 2 BondMembers : @{RealInterface=System.Object[]} Mode : 802.3ad InterfaceType : Bonded GeoTrafficEnable : no DefaultInterface : no New-NetworkInterfaceAdditionalAddress Add an additional address to an interface. New NetworkInterfaceAdditionalAddress Specify an additional address to be used on the interface. New-NetworkInterfaceAdditionalAddress InterfaceID The ID number of the interface to add the additional address to. Int16 Address The additional address to be added. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String New-NetworkInterfaceAdditionalAddress InterfaceID The ID number of the interface to add the additional address to. Int16 Address The additional address to be added. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String InterfaceID The ID number of the interface to add the additional address to. Int16 Int16 Address The additional address to be added. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> New-NetworkInterfaceAdditionalAddress -Address 10.154.11.22 Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Id : 0 IPAddress : 10.154.11.180/16 Mtu : 1400 AdditionalAddresses : @{IPaddress=10.154.11.22/16} InterfaceType : Port GeoTrafficEnable : yes DefaultInterface : yes New-NetworkRoute Add a new IP route to the load balancer. New NetworkRoute Adds an IP route to the routing table on the load balancer. New-NetworkRoute Destination The destination network that needs to be reached. String CIDR The subnet mask of the destination address/network. Int16 Gateway The interface to be used to direct traffic to the desired network. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String New-NetworkRoute Destination The destination network that needs to be reached. String CIDR The subnet mask of the destination address/network. Int16 Gateway The interface to be used to direct traffic to the desired network. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String Destination The destination network that needs to be reached. String String CIDR The subnet mask of the destination address/network. Int16 Int16 Gateway The interface to be used to direct traffic to the desired network. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> New-NetworkRoute -CIDR 16 -Destination 10.154.11.33 -Gateway 10.154.11.23 Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Data field...: @{Route=System.Object[]} Destination : 10.154.11.24/16 Gateway : 10.154.11.44 Destination : 10.154.11.33/16 Gateway : 10.154.11.23 New-NetworkVLAN Allows you to add a Virtual LAN. New NetworkVLAN Add a VLAN. New-NetworkVLAN InterfaceID The ID of the interface to be added to the VLAN. Int16 VLanId The ID of the VLAN. Int16 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String New-NetworkVLAN InterfaceID The ID of the interface to be added to the VLAN. Int16 VLanId The ID of the VLAN. Int16 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String InterfaceID The ID of the interface to be added to the VLAN. Int16 Int16 VLanId The ID of the VLAN. Int16 Int16 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Add-NetworkVLAN -InterfaceID 1 -VLAN 1 Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Data field...: @{Interface=} Id : 2 IPAddress : VlanId : 1 RealInterface : 1 InterfaceType : Vlan GeoTrafficEnable : no DefaultInterface : no New-NetworkVxLAN Creates a new VXLAN interface. New NetworkVxLAN Run this command to create a new VXLAN interface. New-NetworkVxLAN InterfaceID The ID of the interface to add the VXLAN to. Int16 VNI The VxLAN Network Identifier. Int32 Addr The multicast group or remote address. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String New-NetworkVxLAN InterfaceID The ID of the interface to add the VXLAN to. Int16 VNI The VxLAN Network Identifier. Int32 Addr The multicast group or remote address. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String InterfaceID The ID of the interface to add the VXLAN to. Int16 Int16 VNI The VxLAN Network Identifier. Int32 Int32 Addr The multicast group or remote address. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Add-NetworkVxLAN -Addr 10.154.11.34 -InterfaceID 1 -VNI 1 Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Data field...: @{Interface=} Id : 2 IPAddress : VNI : 1 RemoteAddress : 10.154.11.34 RealInterface : 1 InterfaceType : VXlan GeoTrafficEnable : no DefaultInterface : no New-RealServer WARNING: This function is deprecated. Use the following command instead: New-AdcRealServer New RealServer WARNING: This function is deprecated. Use the following command instead: New-AdcRealServer New-RealServer VirtualService String VSPort Int32 VSProtocol String VSIndex Int32 RealServer String RealServerPort Int32 Weight Int32 Forward String Enable Boolean Non_Local Boolean Limit Int64 Critical Boolean Follow Int32 LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String New-RealServer VirtualService String VSPort Int32 VSProtocol String VSIndex Int32 RealServer String RealServerPort Int32 Weight Int32 Forward String Enable Boolean Non_Local Boolean Limit Int64 Critical Boolean Follow Int32 LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String VirtualService String String VSPort Int32 Int32 VSProtocol String String VSIndex Int32 Int32 RealServer String String RealServerPort Int32 Int32 Weight Int32 Int32 Forward String String Enable Boolean Boolean Non_Local Boolean Boolean Limit Int64 Int64 Critical Boolean Boolean Follow Int32 Int32 LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String New-RealServerRule WARNING: This function is deprecated. Use the following command instead: New-AdcRealServerRule New RealServerRule WARNING: This function is deprecated. Use the following command instead: New-AdcRealServerRule New-RealServerRule VirtualService String VSPort Int32 VSProtocol String VSIndex Int32 RealServer String RSPort Int32 RSIndex Int32 RuleName String LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String New-RealServerRule VirtualService String VSPort Int32 VSProtocol String VSIndex Int32 RealServer String RSPort Int32 RSIndex Int32 RuleName String LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String VirtualService String String VSPort Int32 Int32 VSProtocol String String VSIndex Int32 Int32 RealServer String String RSPort Int32 Int32 RSIndex Int32 Int32 RuleName String String LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String New-Route WARNING: This function is deprecated. Use the following command instead: New-NetworkRoute New Route WARNING: This function is deprecated. Use the following command instead: New-NetworkRoute New-Route Destination String CIDR Int16 Gateway String LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String New-Route Destination String CIDR Int16 Gateway String LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String Destination String String CIDR Int16 Int16 Gateway String String LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String New-Rule WARNING: This function is deprecated. Use the following command instead: New-AdcContentRule New Rule WARNING: This function is deprecated. Use the following command instead: New-AdcContentRule New-Rule RuleName String MatchType String IncHost Boolean NoCase Boolean Negate Boolean IncQuery Boolean Header String Pattern String Replacement String Type Int32 LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String New-Rule RuleName String MatchType String IncHost Boolean NoCase Boolean Negate Boolean IncQuery Boolean Header String Pattern String Replacement String Type Int32 LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String RuleName String String MatchType String String IncHost Boolean Boolean NoCase Boolean Boolean Negate Boolean Boolean IncQuery Boolean Boolean Header String String Pattern String String Replacement String String Type Int32 Int32 LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String New-SdnController Add an SDN controller to the LoadMaster. New SdnController Add the specified controller. New-SdnController IPV4 The IPv4 address of the SDN controller. String Port The port of the SDN controller. Int32 Clid The cluster ID for the new SDN controller. If a number is specified, the SDN controller will be added to the cluster with the relevant ID number. The cluster with the ID number specified must already exist. If a number is not specified, the SDN controller will be added to a new cluster. Int32 Https The HTTP method to use. 0 - HTTP 1 - HTTPS Boolean User The username to be used to access the SDN controller RESTful API. String Password The password to be used to access the SDN controller RESTful API. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String New-SdnController IPV4 The IPv4 address of the SDN controller. String Port The port of the SDN controller. Int32 Clid The cluster ID for the new SDN controller. If a number is specified, the SDN controller will be added to the cluster with the relevant ID number. The cluster with the ID number specified must already exist. If a number is not specified, the SDN controller will be added to a new cluster. Int32 Https The HTTP method to use. 0 - HTTP 1 - HTTPS Boolean User The username to be used to access the SDN controller RESTful API. String Password The password to be used to access the SDN controller RESTful API. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String IPV4 The IPv4 address of the SDN controller. String String Port The port of the SDN controller. Int32 Int32 Clid The cluster ID for the new SDN controller. If a number is specified, the SDN controller will be added to the cluster with the relevant ID number. The cluster with the ID number specified must already exist. If a number is not specified, the SDN controller will be added to a new cluster. Int32 Int32 Https The HTTP method to use. 0 - HTTP 1 - HTTPS Boolean Boolean User The username to be used to access the SDN controller RESTful API. String String Password The password to be used to access the SDN controller RESTful API. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> New-SdnController -IPV4 10.123.2.2 -Port 80 Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=Data} Return Code..: 200 Response.....: Command successfully executed. New-SecUser Allows you to add a new local user. New SecUser Allows you to add a new local user. New-SecUser User Username for the new user. String Password Password for the new user. String Radius The radius parameter determines whether the user will use RADIUS server authentication or not when logging in to the LoadMaster. The RADIUS server details must be set up before this option can be used. 0 - Do not use RADIUS authentication 1 - Use RADIUS authentication Boolean NoPassword This option is only valid if session management is enabled. Set this option to yes to create a user with no password. This can be used to allow certificate-based access. SwitchParameter LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String New-SecUser User Username for the new user. String Password Password for the new user. String Radius The radius parameter determines whether the user will use RADIUS server authentication or not when logging in to the LoadMaster. The RADIUS server details must be set up before this option can be used. 0 - Do not use RADIUS authentication 1 - Use RADIUS authentication Boolean NoPassword This option is only valid if session management is enabled. Set this option to yes to create a user with no password. This can be used to allow certificate-based access. SwitchParameter LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String User Username for the new user. String String Password Password for the new user. String String Radius The radius parameter determines whether the user will use RADIUS server authentication or not when logging in to the LoadMaster. The RADIUS server details must be set up before this option can be used. 0 - Do not use RADIUS authentication 1 - Use RADIUS authentication Boolean Boolean NoPassword This option is only valid if session management is enabled. Set this option to yes to create a user with no password. This can be used to allow certificate-based access. SwitchParameter SwitchParameter LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> New-SecUser -Password password1234 -Radius 0 -User ExampleUsername Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. New-SecUserCertificate Generate a new certificate for a user. New SecUserCertificate Generate a new certificate for a user. New-SecUserCertificate User The username of the user to generate the certificate for. String Passphrase The passphrase is optional. If entered, it will be used to encrypt the private key. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String New-SecUserCertificate User The username of the user to generate the certificate for. String Passphrase The passphrase is optional. If entered, it will be used to encrypt the private key. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String User The username of the user to generate the certificate for. String String Passphrase The passphrase is optional. If entered, it will be used to encrypt the private key. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> New-SecUserCertificate -User Example Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. New-SSODomain Allows you to create a new Single Sign-On (SSO) Domain. New SSODomain Allows you to create a new Single Sign-On (SSO) Domain. New-SSODomain Domain Specifies the name of the SSO domain LoadMaster entry to be modified. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String Domain Specifies the name of the SSO domain LoadMaster entry to be modified. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String InformationAction ActionPreference ActionPreference InformationVariable String String You can only use one login method - either certificate or credential. You cannot use both. -------------------------- Example -------------------------- PS C:\> New-SSODomain -Domain example3.com Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed (Domain "example3.com" created); Data=} Return Code..: 200 Response.....: Command successfully executed (Domain "example3.com" created) New-TlsCertificate Allows you to add a certificate to the LoadMaster. New TlsCertificate Allows you to add a certificate to the LoadMaster. New-TlsCertificate Name The identifier that the certificate is known as on the LoadMaster. String Password The password for the certificate file to be uploaded. String Replace Specifies if this certificate replaces an existing certificate already installed. SwitchParameter Path The local path to the certificate file. The certificate file can be either .PEM or .PFX (IIS) format String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String New-TlsCertificate Name The identifier that the certificate is known as on the LoadMaster. String Password The password for the certificate file to be uploaded. String Replace Specifies if this certificate replaces an existing certificate already installed. SwitchParameter Path The local path to the certificate file. The certificate file can be either .PEM or .PFX (IIS) format String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String Name The identifier that the certificate is known as on the LoadMaster. String String Password The password for the certificate file to be uploaded. String String Replace Specifies if this certificate replaces an existing certificate already installed. SwitchParameter SwitchParameter Path The local path to the certificate file. The certificate file can be either .PEM or .PFX (IIS) format String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> New-TlsCertificate -Name mycert -Password password -Path "C:\certs\mycert.pem" Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. New-TlsHSMClientCert Generates the local client certificate that is to be uploaded to the HSM. New TlsHSMClientCert Generates the local client certificate that is to be uploaded to the HSM. New-TlsHSMClientCert Path The path to where you want the generated certificate file to be downloaded to. String Clcertname Provide a name for the generated file. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Force Enable this parameter to force the command to execute without a confirmation. SwitchParameter InformationAction ActionPreference InformationVariable String New-TlsHSMClientCert Path The path to where you want the generated certificate file to be downloaded to. String Clcertname Provide a name for the generated file. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String Force Enable this parameter to force the command to execute without a confirmation. SwitchParameter InformationAction ActionPreference InformationVariable String Path The path to where you want the generated certificate file to be downloaded to. String String Clcertname Provide a name for the generated file. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object Force Enable this parameter to force the command to execute without a confirmation. SwitchParameter SwitchParameter InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> New-TlsHSMClientCert –Clcertname <CertificateName> -Path “<PathToDownloadTheGeneratedFileTo>” Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. New-TlsIntermediateCertificate Allows you to add a certificate to the LoadMaster. New TlsIntermediateCertificate Allows you to add a certificate to the LoadMaster. New-TlsIntermediateCertificate Name The name of the intermediate certificate to be added to the LoadMaster. String Path The local path to the intermediate certificate file. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String New-TlsIntermediateCertificate Name The name of the intermediate certificate to be added to the LoadMaster. String Path The local path to the intermediate certificate file. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String Name The name of the intermediate certificate to be added to the LoadMaster. String String Path The local path to the intermediate certificate file. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> New-TlsIntermediateCertificate -Name certificate.pem -Password password -Path "C:\certs\certificates" Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. New-VirtualService WARNING: This function is deprecated. Use the following command instead: New-AdcVirtualService New VirtualService WARNING: This function is deprecated. Use the following command instead: New-AdcVirtualService New-VirtualService VirtualService String VSPort Int32 VSProtocol String AddVia Int16 Template String Cache Boolean CertFile String CheckType String CheckHost String CheckPattern String CheckUrl String CheckHeaders String LdapEndpoint String MatchLen String CheckUse1_1 Int32 CheckPort Int32 EnhancedHealthChecks Boolean RsMinimum Int32 ClientCert Int16 Compress Boolean Cookie String CachePercent Int16 DefaultGW String Enable Boolean ErrorCode String ErrorUrl String PortFollow Int32 ForceL7 Boolean Idletime Int32 LocalBindAddresses String[] VSType String Nickname String Persist String PersistTimeout Int32 QueryTag String CipherSet String SSLReencrypt Boolean SSLReverse Boolean SSLRewrite String ReverseSNIHostname String Schedule String ServerInit Int16 SSLAcceleration Boolean StandByAddr String StandByPort String TransactionLimit Int32 Transparent Boolean SubnetOriginating Boolean UseforSnat Boolean QoS String CheckUseGet Int32 Verify Int16 ExtraHdrKey String ExtraHdrValue String AllowedHosts String AllowedDirectories String AllowedGroups String GroupSIDs String IncludeNestedGroups Boolean DisplayPubPriv Boolean DisablePasswordForm Boolean Domain String AltDomains String Logoff String ESPLogs Int16 SMTPAllowedDomains String ESPEnabled Boolean UserPwdChangeUrl String UserPwdChangeMsg String InputAuthMode Int16 OutputAuthMode Int16 StartTLSMode Int16 ExtraPorts String AltAddress String MultiConnect Boolean SingleSignOnDir String OCSPVerify String FollowVSID Int32 TlsType Boolean CheckPostData String CheckCodes String PreProcPrecedence String PreProcPrecedencePos Int16 RequestPrecedence String RequestPrecedencePos Int16 ResponsePrecedence String ResponsePrecedencePos Int16 RsRulePrecedence String RsRulePrecedencePos Int16 NeedHostName Boolean CopyHdrFrom String CopyHdrTo String LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String New-VirtualService VirtualService String VSPort Int32 VSProtocol String AddVia Int16 Template String Cache Boolean CertFile String CheckType String CheckHost String CheckPattern String CheckUrl String CheckHeaders String LdapEndpoint String MatchLen String CheckUse1_1 Int32 CheckPort Int32 EnhancedHealthChecks Boolean RsMinimum Int32 ClientCert Int16 Compress Boolean Cookie String CachePercent Int16 DefaultGW String Enable Boolean ErrorCode String ErrorUrl String PortFollow Int32 ForceL7 Boolean Idletime Int32 LocalBindAddresses String[] VSType String Nickname String Persist String PersistTimeout Int32 QueryTag String CipherSet String SSLReencrypt Boolean SSLReverse Boolean SSLRewrite String ReverseSNIHostname String Schedule String ServerInit Int16 SSLAcceleration Boolean StandByAddr String StandByPort String TransactionLimit Int32 Transparent Boolean SubnetOriginating Boolean UseforSnat Boolean QoS String CheckUseGet Int32 Verify Int16 ExtraHdrKey String ExtraHdrValue String AllowedHosts String AllowedDirectories String AllowedGroups String GroupSIDs String IncludeNestedGroups Boolean DisplayPubPriv Boolean DisablePasswordForm Boolean Domain String AltDomains String Logoff String ESPLogs Int16 SMTPAllowedDomains String ESPEnabled Boolean UserPwdChangeUrl String UserPwdChangeMsg String InputAuthMode Int16 OutputAuthMode Int16 StartTLSMode Int16 ExtraPorts String AltAddress String MultiConnect Boolean SingleSignOnDir String OCSPVerify String FollowVSID Int32 TlsType Boolean CheckPostData String CheckCodes String PreProcPrecedence String PreProcPrecedencePos Int16 RequestPrecedence String RequestPrecedencePos Int16 ResponsePrecedence String ResponsePrecedencePos Int16 RsRulePrecedence String RsRulePrecedencePos Int16 NeedHostName Boolean CopyHdrFrom String CopyHdrTo String LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String VirtualService String String VSPort Int32 Int32 VSProtocol String String AddVia Int16 Int16 Template String String Cache Boolean Boolean CertFile String String CheckType String String CheckHost String String CheckPattern String String CheckUrl String String CheckHeaders String String LdapEndpoint String String MatchLen String String CheckUse1_1 Int32 Int32 CheckPort Int32 Int32 EnhancedHealthChecks Boolean Boolean RsMinimum Int32 Int32 ClientCert Int16 Int16 Compress Boolean Boolean Cookie String String CachePercent Int16 Int16 DefaultGW String String Enable Boolean Boolean ErrorCode String String ErrorUrl String String PortFollow Int32 Int32 ForceL7 Boolean Boolean Idletime Int32 Int32 LocalBindAddresses String[] String[] VSType String String Nickname String String Persist String String PersistTimeout Int32 Int32 QueryTag String String CipherSet String String SSLReencrypt Boolean Boolean SSLReverse Boolean Boolean SSLRewrite String String ReverseSNIHostname String String Schedule String String ServerInit Int16 Int16 SSLAcceleration Boolean Boolean StandByAddr String String StandByPort String String TransactionLimit Int32 Int32 Transparent Boolean Boolean SubnetOriginating Boolean Boolean UseforSnat Boolean Boolean QoS String String CheckUseGet Int32 Int32 Verify Int16 Int16 ExtraHdrKey String String ExtraHdrValue String String AllowedHosts String String AllowedDirectories String String AllowedGroups String String GroupSIDs String String IncludeNestedGroups Boolean Boolean DisplayPubPriv Boolean Boolean DisablePasswordForm Boolean Boolean Domain String String AltDomains String String Logoff String String ESPLogs Int16 Int16 SMTPAllowedDomains String String ESPEnabled Boolean Boolean UserPwdChangeUrl String String UserPwdChangeMsg String String InputAuthMode Int16 Int16 OutputAuthMode Int16 Int16 StartTLSMode Int16 Int16 ExtraPorts String String AltAddress String String MultiConnect Boolean Boolean SingleSignOnDir String String OCSPVerify String String FollowVSID Int32 Int32 TlsType Boolean Boolean CheckPostData String String CheckCodes String String PreProcPrecedence String String PreProcPrecedencePos Int16 Int16 RequestPrecedence String String RequestPrecedencePos Int16 Int16 ResponsePrecedence String String ResponsePrecedencePos Int16 Int16 RsRulePrecedence String String RsRulePrecedencePos Int16 Int16 NeedHostName Boolean Boolean CopyHdrFrom String String CopyHdrTo String String LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String New-VSPacketFilterACL Adds an address to the black or white list for a Virtual Service. New VSPacketFilterACL Adds a host or network IP address to the black or white access control list for a specific Virtual Service. Note that black and white lists are only enabled when packet filtering is enabled. New-VSPacketFilterACL VirtualService Specifies the Virtual Service IP address. String VSPort Specifies the Virtual Service port number. Int32 VSProtocol Specifies the Virtual Service protocol. String Type Specify the type of list: - black: blocked addresses - white: allowed addresses Note: This is case sensitive – the type value should be in lowercase. String AclAddress Specifies a host or network IP address to add to the access control list. The address can be specified in CIDR format. If the CIDR is not specified, the system uses a default of /32. String AclComment Optionally specify a comment in relation to the list entry. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String New-VSPacketFilterACL VirtualService Specifies the Virtual Service IP address. String VSPort Specifies the Virtual Service port number. Int32 VSProtocol Specifies the Virtual Service protocol. String Type Specify the type of list: - black: blocked addresses - white: allowed addresses Note: This is case sensitive – the type value should be in lowercase. String AclAddress Specifies a host or network IP address to add to the access control list. The address can be specified in CIDR format. If the CIDR is not specified, the system uses a default of /32. String AclComment Optionally specify a comment in relation to the list entry. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String VirtualService Specifies the Virtual Service IP address. String String VSPort Specifies the Virtual Service port number. Int32 Int32 VSProtocol Specifies the Virtual Service protocol. String String Type Specify the type of list: - black: blocked addresses - white: allowed addresses Note: This is case sensitive – the type value should be in lowercase. String String AclAddress Specifies a host or network IP address to add to the access control list. The address can be specified in CIDR format. If the CIDR is not specified, the system uses a default of /32. String String AclComment Optionally specify a comment in relation to the list entry. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> New-VSPacketFilterACL -AclAddress 10.134.33.2 -Type black -VirtualService 10.35.47.16 -VSPort 80 -VSProtocol tcp Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. New-WafCustomRuleData Upload a custom rule data file. New WafCustomRuleData This command allows you to upload a custom rule data file to the LoadMaster. New-WafCustomRuleData Path The path where the custom rule data file is stored followed by a back slash and the filename/extension. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String New-WafCustomRuleData Path The path where the custom rule data file is stored followed by a back slash and the filename/extension. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String Path The path where the custom rule data file is stored followed by a back slash and the filename/extension. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String Filename The filename of the custom rule data file followed by the file extension (.data). string string -------------------------- Example -------------------------- PS C:\> New-WafCustomRuleData -Filename modsecurity_35_bad_robots.data -Path C:\t\modsecurity_35_bad_robots.data Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. New-WafCustomRuleSet Upload custom Web Application Firewall (WAF) rule files or a rule set. New WafCustomRuleSet Upload custom WAF rule files or a rule set to the LoadMaster. New-WafCustomRuleSet Path The path to the custom rule file(s) or rule set file followed by a forward slash and then the filename.extension. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String New-WafCustomRuleSet Path The path to the custom rule file(s) or rule set file followed by a forward slash and then the filename.extension. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String Path The path to the custom rule file(s) or rule set file followed by a forward slash and then the filename.extension. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String Filename The desired rule name to be displayed on the WUI. This is only relevant for individual rule files. string string -------------------------- Example -------------------------- PS C:\> New-WafCustomRuleSet -Filename modsecurity_crs_40_generic_attacks.conf -Path C:\WAF\modsecurity-crs_2.2.5\modsecurity-crs_2.2.5\base_rules\modsecurity_crs_40_generic_attacks.conf Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. NMAddNode WARNING: This function is deprecated. Use the following command instead: New-ClusterNode WARNING: This function is deprecated. Use the following command instead: New-ClusterNode NMAddNode Address String LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String NMAddNode Address String LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String Address String String LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String NMClusterCreate WARNING: This function is deprecated. Use the following command instead: New-Cluster WARNING: This function is deprecated. Use the following command instead: New-Cluster NMClusterCreate SharedAddress String LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String NMClusterCreate SharedAddress String LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String SharedAddress String String LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String NMClusterStatus WARNING: This function is deprecated. Use the following command instead: Get-ClusterStatus WARNING: This function is deprecated. Use the following command instead: Get-ClusterStatus NMClusterStatus LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String NMClusterStatus LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String NMDeleteNode WARNING: This function is deprecated. Use the following command instead: Remove-ClusterNode WARNING: This function is deprecated. Use the following command instead: Remove-ClusterNode NMDeleteNode NodeId Int32 LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String NMDeleteNode NodeId Int32 LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String NodeId Int32 Int32 LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String NMDisableNode WARNING: This function is deprecated. Use the following command instead: Disable-ClusterNode WARNING: This function is deprecated. Use the following command instead: Disable-ClusterNode NMDisableNode NodeId Int32 LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String NMDisableNode NodeId Int32 LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String NodeId Int32 Int32 LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String NMEnableNode WARNING: This function is deprecated. Use the following command instead: Enable-ClusterNode WARNING: This function is deprecated. Use the following command instead: Enable-ClusterNode NMEnableNode NodeId Int32 LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String NMEnableNode NodeId Int32 LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String NodeId Int32 Int32 LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String NMJoinCluster WARNING: This function is deprecated. Use the following command instead: Join-Cluster WARNING: This function is deprecated. Use the following command instead: Join-Cluster NMJoinCluster LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String NMJoinCluster LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String Ping-Host Ping the specified host. Ping Host The ping command displays whether the destination responded and how long it took to receive a reply. The destination can be an IP address or a Fully Qualified Domain Name (FQDN). Ping-Host Address The destination address to ping. The destination can be an IP address or a FQDN. String PingClass Specify ping for IPv4 addresses or ping6 for IPv6 addresses. String Interface Specify the ID of the interface from which the ping should be sent from. If the interface is not specified here, the correct interface to ping an address on a particular network will be automatically selected. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Ping-Host Address The destination address to ping. The destination can be an IP address or a FQDN. String PingClass Specify ping for IPv4 addresses or ping6 for IPv6 addresses. String Interface Specify the ID of the interface from which the ping should be sent from. If the interface is not specified here, the correct interface to ping an address on a particular network will be automatically selected. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String Address The destination address to ping. The destination can be an IP address or a FQDN. String String PingClass Specify ping for IPv4 addresses or ping6 for IPv6 addresses. String String Interface Specify the ID of the interface from which the ping should be sent from. If the interface is not specified here, the correct interface to ping an address on a particular network will be automatically selected. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Ping-Host -Address 10.154.190.207 -PingClass ping Example Output: Full response: @{ReturnCode=422; Response=Command Failed; Data=} Return Code..: 422 Response.....: Command Failed Data field...: @{PingResult=Command Failed: PING 10.35.47.8 (10.35.47.8) 56(84) bytes of data. From 10.35.47.15 icmp_seq=1 Destination Host Unreachable From 10.35.47.15 icmp_seq=2 Destination Host Unreachable From 10.35.47.15 icmp_seq=3 Destination Host Unreachable; PacketsTransmitted=3 packets transmit ted; PacketsReceived=0 received; Errors=+3 errors; PacketsLoss=100% packet loss; Time=} Read-LicenseEULA Displays the EULA and a magic cookie. Read LicenseEULA The End User License Agreement (EULA) and magic cookie will be displayed. Read-LicenseEULA LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String -------------------------- Example -------------------------- PS C:\> $read = Read-LicenseEULA Example Output: Full response: @{MagicString=013b50b2-e3bb-468e-b64a-de78d46cdfb8; Eula=... Return Code..: 200 Response.....: Command successfully executed Data field...: Eula ---- @{MagicString=013b50b2-e3bb-468e-b64a-de78d46cdfb8; Eula=... Param........: <p style="text-align:center"><h2>LoadMaster End User License Agreement</h2></p> <p style="text-align:center">KEMP Technologies END-USER PRODUCT LICENSE AGREEMENT</p> <p> 1. READ THE FOLLOWING TERMS AND CONDITIONS CAREFULLY BEFORE INSTALLING THIS PRODUCT ON YOUR NETWORK OR PERSONAL COMPUTER. THIS PRODUCT LICENSE AGREEMENT IS A LEGAL AGREEMENT BETWEEN YOU (EITHE R ON BEHALF OF YOURSELF AS AN INDIVIDUAL OR ON BEHALF OF AN ENTITY AS ITS AUTHORIZED REPRESENTATIVE) ON THE ONE HAND, AND KEMP Technologies, INC. AND ITS SUBSIDIARIES AND AFFILIATES (COLLECTIV ELY REFERRED TO AS 'KEMP') ON THE OTHER HAND, FOR THE HARDWARE AND/OR SOFTWARE PRODUCT ENTITLED 'LoadMaster,' WHICH INCLUDES PHYSICAL HARDWARE AND/OR COMPUTER SOFTWARE AND ANY ASSOCIATED MEDIA , PRINTED MATERIALS, AND/OR 'ONLINE' OR ELECTRONIC DOCUMENTATION (TOGETHER CALLED THE 'PRODUCT'). PLEASE READ THIS AGREEMENT CAREFULLY AND PRINT OUT A COPY FOR YOUR RECORDS. THIS AGREEMENT SUP ERSEDES PREVIOUS VERSIONS.</p> <br /> <p>BY INSTALLING, COPYING, OR OTHERWISE USING THE PRODUCT, YOU ACKNOWLEDGE THAT YOU HAVE READ THIS PRODUCT LICENSE AGREEMENT AND AGREE TO BE BOUND BY ITS TERMS. THE PRODUCT IS LICENSED, NOT SO LD, TO YOU FOR USE ONLY UNDER THE TERMS OF THIS AGREEMENT. IF YOU DO NOT AGREE TO THE TERMS OF THIS PRODUCT LICENSE AGREEMENT, DO NOT INSTALL OR USE THE PRODUCT AND DELETE ALL COPIES IN YOUR P OSSESSION. </p> <br /> <p>2. KEMP grants you a non-exclusive, non-transferable license to use one copy of the Product in the country in which you acquired the Product for your own personal or commercial use, but ret ains all property rights in the Product and all copies thereof. All other rights are expressly reserved by KEMP. You may: (i) use the Product on any supported computer configuration, provided the Product is used on only one (1) such computer; and (ii) permanently transfer the Product and its documentation to another user provided you retain no copies and the recipient agrees to the terms of this Agreement. You may not transfer, distribute, rent, sub-license, or lease the Product or documentation, except as provided herein; or alter, modify, or adapt the Product or docum entation, or any portions thereof.</p> <br /> <p>3. You acknowledge that the Product in source code form remains a confidential trade secret of KEMP. You agree not to modify or attempt to reverse engineer, decompile, or disassemble the Pr oduct, except and only to the extent that such activity is expressly permitted by applicable law notwithstanding this limitation.</p> <br /> <p>4. OWNERSHIP: All right, title and interest and intellectual property rights in and to the Product (including but not limited to any titles, computer code, concepts, screen images, text and 'applets,' incorporated into the Product), the accompanying printed materials, and any copies of the Software, are owned by KEMP or its licensors. This Agreement grants you no rights to use s uch content other than as part of the Product.</p> <br /> <p>5. This Agreement is effective upon your installation of the Product and shall continue until revoked by KEMP or until you breach any term hereof; upon termination you agree to destroy and/ or delete all copies of the Product in your possession. </p> <br /> <p>6. LICENSE RESTRICTIONS: You acknowledge that the foregoing license extends only to your use of the features and functionality of the Product as described in the documentation accompanying the version of the Software downloaded or Product obtained by you (the "Documentation"), and you agree not to reconfigure or modify the Product in order to enable features or functionality dif ferent than those described in such Documentation or available in other KEMP products without notifying KEMP and paying the applicable Product upgrade fee. You may not: (i) reverse engineer, d ecompile, or disassemble the Product; (ii) modify, or create derivative works based upon, the Product in whole or in part; (iii) distribute copies of the Product; (iv) remove any proprietary n otices or labels on the Product; or (v) resell, lease, rent, transfer, sublicense, or otherwise transfer rights to the Product. Any use in violation of this Section shall immediately terminate your license to the Product.</p> <br /> <p>7. TITLE: You agree that no title to the intellectual property in the Product, Subscription Services (as defined), or license keys is transferred to you. Title, ownership, rights, and intel lectual property rights in and to the Product, Subscription Services, and license keys shall remain in KEMP and/or KEMP's licensors. The Product, Subscription Services and license keys are pro tected by intellectual property laws of the United States and other countries and by international treaties.</p> <br /> <p>8. GENERAL: The Product is provided to you at minimal charge. KEMP does not guarantee that use of the Product will be uninterrupted or error-free. You acknowledge that performance of the Pr oduct may be affected by any number of factors, including without limitation, technical failure of the Product, the acts or omissions of third parties and other causes reasonably beyond the co ntrol of KEMP. Certain features of the Product may not be forward-compatible with future versions of the Product and use of such features with future versions of the Product may require purcha se of the applicable future version of the Product.</p> <br /> <p>9. AS IS SALE: YOU AGREE THAT KEMP AND ITS LICENSORS HAVE MADE NO EXPRESS WARRANTIES, ORAL OR WRITTEN, TO YOU REGARDING THE PRODUCT AND THAT THE PRODUCT IS BEING PROVIDED TO YOU "AS IS" WIT HOUT WARRANTY OF ANY KIND. YOU ACKNOWLEDGE THAT THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PRODUCT IS WITH YOU. SHOULD THE PRODUCT PROVE DEFECTIVE, YOU (AND NOT KEMP, THE RETAILE R, OR ANY DISTRIBUTOR) ASSUME THE ENTIRE COST OF ALL NECESSARY REPAIRS.</p> <br /> <p>10. DISCLAIMER: KEMP DISCLAIMS ANY AND ALL OTHER WARRANTIES, WHETHER EXPRESS, IMPLIED, OR STATUTORY, INCLUDING, BUT WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF NONINFRINGEMENT OF THIRD PA RTY RIGHTS, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. THIS WARRANTY DISCLAIMER AFFECTS YOUR LEGAL RIGHTS, AND YOU MAY ALSO HAVE OTHER RIGHTS WHICH VARY FROM JURISDICTION TO JURISDIC TION. SOME JURISDICTIONS DO NOT ALLOW EXCLUSIONS OF IMPLIED WARRANTIES OR LIMITATIONS ON HOW LONG AN IMPLIED WARRANTY LASTS, SO THE ABOVE EXCLUSION MAY NOT APPLY TO YOU.</p> <br /> <p>11. Limitation on Liability. EXCEPT FOR BODILY INJURY OF A PERSON, IN NO EVENT WILL KEMP BE LIABLE TO YOU OR ANY THIRD PARTY FOR ANY DAMAGES ARISING OUT OF THE SUBJECT MATTER OF THIS AGREEM ENT, THE PRODUCT OR ANY SERVICES UNDER ANY CONTRACT, NEGLIGENCE, STRICT LIABILITY OR OTHER THEORY, FOR ANY INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES (INCLUDING LOST PROFITS), OR FOR LOSS OF OR CORRUPTION OF DATA, OR FOR COST OF PROCUREMENT OF SUBSTITUTE GOODS OR TECHNOLOGY, IRRESPECTIVE OF WHETHER KEMP HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. KEMP'S MAXIMU M LIABILITY FOR DAMAGES SHALL BE LIMITED TO THE LICENSE FEES RECEIVED BY KEMP UNDER THIS LICENSE FOR THE PARTICULAR PRODUCT(S) WHICH CAUSED THE DAMAGES. Some jurisdictions do not allow the exc lusion or limitation of incidental or consequential damages, so the above limitation or exclusion may not apply to You.</p> <br /> <p>12. TERMINATION: This Agreement shall terminate automatically if you fail to comply with the terms of this Agreement. No notice shall be required from KEMP to effect such termination. You m ay also terminate this Agreement at any time by notifying KEMP in writing of termination. Upon any termination of this Agreement, you must uninstall and destroy all copies of the Product.</p> <br /> <p>13. MISCELLANEOUS:</p> <p>13.1 COMPLIANCE WITH EXPORT CONTROL LAWS: End User agrees to comply fully with all relevant export laws and regulations, including but not limited to the U.S. Export Administration Regulati ons and regulations promulgated by the U.S. Department of the Treasury's Office of Foreign Assets Control ("OFAC"), as amended from time to time (collectively, the "Export Control Laws"). End User agrees not to export or reexport the Product to any parties located in any E:1countries which are specifically prohibited under U.S. embargoes or sanctions programs maintained by the OFAC or otherwise prohibited under the Export Control Laws. The current list of E:1 Countries is available at the following link http://www.bis.doc.gov/index.php/forms-documents/doc_view/452-sup plement-no-1-to-part-740-country-groups</p> <br /> <p>13.2 U.S. GOVERNMENT RIGHTS: The Product under this Agreement is commercial computer product as that term is described in 48 C.F.R. 252.227-7014(a)(1). If acquired by or on behalf of a civi lian agency, the U.S. Government acquires this commercial computer product and/or commercial computer product documentation subject to the terms of this Agreement as specified in 48 C.F.R. 12. 212 (Computer Product) and 12.211 (Technical Data) of the Federal Acquisition Regulations ("FAR") and its successors. If acquired by or on behalf of any agency within the Department of Defense ("DOD"), the U.S. Government acquires this commercial computer product and/or commercial computer product documentation subject to the terms of this Agreement as specified in 48 C.F.R. 227.72 02-3 of the DOD FAR Supplement ("DFAR") and its successors.</p> <br /> <p>13.3 GOVERNING LAW: This Agreement will be governed by the laws of the State of New York as they are applied to agreements between New York residents entered into and to be performed entire ly within New York. The United Nations Convention on Contracts for the International Sale of Goods is specifically disclaimed.</p> <br /> <p>13.4 ENTIRE AGREEMENT: You agree that this is the entire agreement between you and KEMP, and that it supersedes any prior agreement, whether written or oral, and all other communications be tween KEMP and you relating to the subject matter of this Agreement. This Agreement may be amended, modified or supplemented only by a writing that is signed by the authorized representatives of both parties.</p> <br /> <p>13.5 RESERVATION OF RIGHTS: All rights not expressly granted in this Agreement are reserved by KEMP.</p> <br /> <p>14. INJUNCTION. Because KEMP would be irreparably damaged if the terms of this License Agreement were not specifically enforced, you agree that KEMP shall be entitled, without bond, other s ecurity or proof of damages, to appropriate equitable remedies with respect to breaches of this Agreement, in addition to such other remedies as KEMP may otherwise have under applicable laws.< /p> <br /> <p>15. INDEMNITY. At KEMP's request, you agree to defend, indemnify and hold harmless KEMP, its subsidiaries, affiliates, contractors, officers, directors, employees, agents, licensors, licens ees, distributors, developers, content providers, and other users of the Product, from all damages, losses, liabilities, claims and expenses, including attorneys' fees, arising directly or ind irectly from your acts and omissions to act in using the Product pursuant to the terms of this License Agreement or any breach of this License Agreement by you. KEMP reserves the right, at its own expense, to assume the exclusive defense and control of any matter otherwise subject to indemnification by you hereunder, and in such event, you shall have no further obligation to provid e indemnification for such matter. </p> <br /> <p>16. TERMINATION. Without prejudice to any other rights of KEMP, this License Agreement and your right to use the Product may automatically terminate without notice from KEMP if you fail to comply with any provision of this Agreement or any terms and conditions associated with the Product. In such event, you must destroy all copies of this Product and all of its component parts.< /p> <br /> <p>17. GENERAL PROVISIONS. You may not use, copy, modify, sublicense, rent, sell, assign or transfer the rights or obligations granted to you in this Agreement, except as expressly provided in this Agreement. Any assignment in violation of this Agreement is void, except that you may transfer your Product to another person provided that person accepts the terms of this License Agree ment. If any provision of this Agreement is held to be unenforceable for any reason, such provision shall be reformed only to the extent necessary to make it enforceable, and such decision sha ll not affect the enforceability of: (i) such provision under other circumstances, or (ii) the remaining provisions hereof under all circumstances. KEMP's failure to enforce at any time any of the provisions of this Agreement shall in no way be construed to be a present or future waiver of such provisions, nor in any way affect the right of any party to enforce each and every such provision thereafter. The express waiver by KEMP of any provision, condition or requirement of this Agreement shall not constitute a waiver of any future obligation to comply with such provisi on, condition or requirement. Notwithstanding anything else in this Agreement, no default, delay or failure to perform on the part of KEMP shall be considered a breach of this Agreement if suc h default, delay or failure to perform is shown to be due to causes beyond the reasonable control of KEMP. This Agreement represents the complete agreement concerning this License Agreement be tween you and KEMP. </p> <br /> <p>Copyright (c) 2002-2017 KEMP Technologies, Inc.</p> <p style="text-align:center"> If you do not agree with terms put forth above contact your KEMP Representative for further information and help. </p> Register-BondedInterface WARNING: This function is deprecated. Use the following command instead: Register-NetworkBondedInterface Register BondedInterface WARNING: This function is deprecated. Use the following command instead: Register-NetworkBondedInterface Register-BondedInterface InterfaceID Int16 LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String Register-BondedInterface InterfaceID Int16 LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String InterfaceID Int16 Int16 LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String Register-NetworkBondedInterface Enables you to register the address of a bonded interface. Register NetworkBondedInterface This command waits two minutes to reconnect to the LoadMaster. If the wait time is longer than two minutes, an error message appears. Register-NetworkBondedInterface InterfaceID The interface ID that you are registering to the bonded interface. To view the interface ID for each of the interfaces, run the Get-Statistics command. The interface ID is the first number displayed in each interface row. Int16 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Register-NetworkBondedInterface InterfaceID The interface ID that you are registering to the bonded interface. To view the interface ID for each of the interfaces, run the Get-Statistics command. The interface ID is the first number displayed in each interface row. Int16 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String InterfaceID The interface ID that you are registering to the bonded interface. To view the interface ID for each of the interfaces, run the Get-Statistics command. The interface ID is the first number displayed in each interface row. Int16 Int16 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Register-NetworkBondedInterface -InterfaceID 0 Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Data field...: @{Interface=} Id : 0 IPAddress : 10.154.11.180/16 Mtu : 1400 AdditionalAddresses : @{IPaddress=10.154.11.22/16} NBondMembers : 1 BondMembers : @{RealInterface=0} Mode : 802.3ad InterfaceType : Bonded GeoTrafficEnable : yes DefaultInterface : yes Remove-AdcContentRule Allows you to remove a specified rule from the LoadMaster. Remove AdcContentRule Allows you to remove a specified rule from the LoadMaster. Remove-AdcContentRule RuleName The name of the content rule to remove. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Force Enable this parameter to force the command to execute without a confirmation. SwitchParameter InformationAction ActionPreference InformationVariable String WhatIf Enable this parameter to see what the command will do without actually executing the command. SwitchParameter Confirm Confirms that the action should be carried out. SwitchParameter Remove-AdcContentRule RuleName The name of the content rule to remove. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String Force Enable this parameter to force the command to execute without a confirmation. SwitchParameter InformationAction ActionPreference InformationVariable String WhatIf Enable this parameter to see what the command will do without actually executing the command. SwitchParameter Confirm Confirms that the action should be carried out. SwitchParameter RuleName The name of the content rule to remove. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object Force Enable this parameter to force the command to execute without a confirmation. SwitchParameter SwitchParameter InformationAction ActionPreference ActionPreference InformationVariable String String WhatIf Enable this parameter to see what the command will do without actually executing the command. SwitchParameter SwitchParameter Confirm Confirms that the action should be carried out. SwitchParameter SwitchParameter CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String Name The name of the rule. This parameter is required. string string -------------------------- Example -------------------------- PS C:\> Remove-AdcContentRule -Name TestRule2 -Confirm Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Remove-AdcHttpCacheException Allows you to remove an extension from the 'Do Not Cache' extension list. Remove AdcHttpCacheException Allows you to remove an extension from the 'Do Not Cache' extension list. Remove-AdcHttpCacheException Extension The file extension that should be removed from the "no cache" list. The extension must start with "." For example: ".jpg" This parameter is required. String[] LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Remove-AdcHttpCacheException Extension The file extension that should be removed from the "no cache" list. The extension must start with "." For example: ".jpg" This parameter is required. String[] LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String Extension The file extension that should be removed from the "no cache" list. The extension must start with "." For example: ".jpg" This parameter is required. String[] String[] LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Remove-AdcHttpCacheException -Extension .mp4 Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Remove-AdcHttpCompressionException Allows you to remove an extension from the 'Do Not Compress' extension list. Remove AdcHttpCompressionException Allows you to remove an extension from the 'Do Not Compress' extension list. Remove-AdcHttpCompressionException Extension The file extension that should be removed from the "no compress" list. The extension must start with "." For example: ".jpg" This parameter is required. String[] LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Remove-AdcHttpCompressionException Extension The file extension that should be removed from the "no compress" list. The extension must start with "." For example: ".jpg" This parameter is required. String[] LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String Extension The file extension that should be removed from the "no compress" list. The extension must start with "." For example: ".jpg" This parameter is required. String[] String[] LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Remove-AdcHttpCompressionException -Extension .mp4 Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Remove-AdcRealServer Allows you to remove a Real Server from a Virtual Service. Remove AdcRealServer Allows you to remove a Real Server from a Virtual Service. Remove-AdcRealServer VirtualService The IP Address of the Virtual Service that connects to this Real Server. String VSPort The port of the Virtual Service to remove. Int32 VSProtocol The protocol of the Virtual Service to remove. String VSIndex The index number of the relevant Virtual Service or SubVS. To retrieve the VSIndex, run the Get-VirtualService command. Int32 RealServer The Real Server IP Address that is a backend server for the Virtual Service. String RealServerPort The port on which the Real Server accepts connections for this service. Int32 RSIndex The index number of the Real Server to be removed. To retrieve the Real Server index, run the Get-VirtualService command. Int32 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Force Enable this parameter to force the command to execute without a confirmation. SwitchParameter InformationAction ActionPreference InformationVariable String WhatIf Provides a method to see what the command will do without actually executing the command. SwitchParameter Confirm Confirms that the action should be carried out. SwitchParameter Remove-AdcRealServer VirtualService The IP Address of the Virtual Service that connects to this Real Server. String VSPort The port of the Virtual Service to remove. Int32 VSProtocol The protocol of the Virtual Service to remove. String VSIndex The index number of the relevant Virtual Service or SubVS. To retrieve the VSIndex, run the Get-VirtualService command. Int32 RealServer The Real Server IP Address that is a backend server for the Virtual Service. String RealServerPort The port on which the Real Server accepts connections for this service. Int32 RSIndex The index number of the Real Server to be removed. To retrieve the Real Server index, run the Get-VirtualService command. Int32 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String Force Enable this parameter to force the command to execute without a confirmation. SwitchParameter InformationAction ActionPreference InformationVariable String WhatIf Provides a method to see what the command will do without actually executing the command. SwitchParameter Confirm Confirms that the action should be carried out. SwitchParameter VirtualService The IP Address of the Virtual Service that connects to this Real Server. String String VSPort The port of the Virtual Service to remove. Int32 Int32 VSProtocol The protocol of the Virtual Service to remove. String String VSIndex The index number of the relevant Virtual Service or SubVS. To retrieve the VSIndex, run the Get-VirtualService command. Int32 Int32 RealServer The Real Server IP Address that is a backend server for the Virtual Service. String String RealServerPort The port on which the Real Server accepts connections for this service. Int32 Int32 RSIndex The index number of the Real Server to be removed. To retrieve the Real Server index, run the Get-VirtualService command. Int32 Int32 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object Force Enable this parameter to force the command to execute without a confirmation. SwitchParameter SwitchParameter InformationAction ActionPreference ActionPreference InformationVariable String String WhatIf Provides a method to see what the command will do without actually executing the command. SwitchParameter SwitchParameter Confirm Confirms that the action should be carried out. SwitchParameter SwitchParameter CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String Port The port on which the Virtual Service accepts connections. int32 int32 Protocol The protocol for communication. Accepts either TCP or UDP. string string -------------------------- Example -------------------------- PS C:\> Remove-AdcRealServer -Force -Port 80 -Protocol tcp -RealServer 10.11.0.24 -RealServerPort 80 -VirtualService 10.11.0.199 Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Remove-AdcRealServerRule Allows you to remove a rule from the Real Server. Remove AdcRealServerRule Allows you to remove a rule from the Real Server. Remove-AdcRealServerRule VirtualService The IP Address of the Virtual Service this rule should be applied to. String VSPort The port of the relevant Virtual Service. Int32 VSProtocol The protocol of the relevant Virtual Service. String VSIndex The index number of the relevant Virtual Service or SubVS. To retrieve the VSIndex, run the Get-VirtualService command. Int32 RealServer The IP address of the relevant Real Server. String RSPort The port number of the relevant Real Server. Int32 RSIndex The index number of the Real Server or SubVS to remove the rule from. To retrieve the Real Server index, run the Get-VirtualService command. Int32 RuleName The name of the rule that should be applied to the Virtual Service. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Force Switch to force the command to execute without a confirmation. SwitchParameter InformationAction ActionPreference InformationVariable String WhatIf Provides a method to see what the command will do without actually executing the command. SwitchParameter Confirm Confirms that the action should be carried out. SwitchParameter Remove-AdcRealServerRule VirtualService The IP Address of the Virtual Service this rule should be applied to. String VSPort The port of the relevant Virtual Service. Int32 VSProtocol The protocol of the relevant Virtual Service. String VSIndex The index number of the relevant Virtual Service or SubVS. To retrieve the VSIndex, run the Get-VirtualService command. Int32 RealServer The IP address of the relevant Real Server. String RSPort The port number of the relevant Real Server. Int32 RSIndex The index number of the Real Server or SubVS to remove the rule from. To retrieve the Real Server index, run the Get-VirtualService command. Int32 RuleName The name of the rule that should be applied to the Virtual Service. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String Force Switch to force the command to execute without a confirmation. SwitchParameter InformationAction ActionPreference InformationVariable String WhatIf Provides a method to see what the command will do without actually executing the command. SwitchParameter Confirm Confirms that the action should be carried out. SwitchParameter VirtualService The IP Address of the Virtual Service this rule should be applied to. String String VSPort The port of the relevant Virtual Service. Int32 Int32 VSProtocol The protocol of the relevant Virtual Service. String String VSIndex The index number of the relevant Virtual Service or SubVS. To retrieve the VSIndex, run the Get-VirtualService command. Int32 Int32 RealServer The IP address of the relevant Real Server. String String RSPort The port number of the relevant Real Server. Int32 Int32 RSIndex The index number of the Real Server or SubVS to remove the rule from. To retrieve the Real Server index, run the Get-VirtualService command. Int32 Int32 RuleName The name of the rule that should be applied to the Virtual Service. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object Force Switch to force the command to execute without a confirmation. SwitchParameter SwitchParameter InformationAction ActionPreference ActionPreference InformationVariable String String WhatIf Provides a method to see what the command will do without actually executing the command. SwitchParameter SwitchParameter Confirm Confirms that the action should be carried out. SwitchParameter SwitchParameter CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String Port The port on which this Virtual Service accepts connections. int32 int32 Protocol The protocol for communication. Accepts either TCP or UDP. string string -------------------------- Example -------------------------- PS C:\> Remove-AdcRealServerRule -Port 80 -Protocol tcp -RealServer 10.11.0.24 -RSPort 80 -RuleName TestRule1 -VirtualService 10.11.0.200 Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Remove-AdcSubVirtualService Remove a SubVS. Remove AdcSubVirtualService This command removes the specified SubVS. Remove-AdcSubVirtualService SubVSIndex The index number of the SubVS to delete. Int32 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Force Switch to force the command to execute without a confirmation. SwitchParameter InformationAction ActionPreference InformationVariable String WhatIf Provides a method to see what the command will do without actually executing the command. SwitchParameter Confirm Confirms that the action should be carried out. SwitchParameter Remove-AdcSubVirtualService SubVSIndex The index number of the SubVS to delete. Int32 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String Force Switch to force the command to execute without a confirmation. SwitchParameter InformationAction ActionPreference InformationVariable String WhatIf Provides a method to see what the command will do without actually executing the command. SwitchParameter Confirm Confirms that the action should be carried out. SwitchParameter SubVSIndex The index number of the SubVS to delete. Int32 Int32 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object Force Switch to force the command to execute without a confirmation. SwitchParameter SwitchParameter InformationAction ActionPreference ActionPreference InformationVariable String String WhatIf Provides a method to see what the command will do without actually executing the command. SwitchParameter SwitchParameter Confirm Confirms that the action should be carried out. SwitchParameter SwitchParameter CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Remove-AdcSubVirtualService -SubVSIndex 2 Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Remove-AdcVirtualServerRule WARNING: This function is deprecated. Use the following command instead: Remove-AdcVirtualServiceRule Remove AdcVirtualServerRule WARNING: This function is deprecated. Use the following command instead: Remove-AdcVirtualServiceRule Remove-AdcVirtualServerRule VirtualService Specifies the IP Address of the Virtual Service that this rule should be applied to. String VSPort Int32 VSProtocol String VSIndex The index number of the relevant Virtual Service or SubVS. To retrieve the Virtual Service index, run the Get-VirtualService command. Int32 RuleType Specifies if the rule is a pre-processing rule, a response rule, or a request rule. Valid options are "pre", "response", and "request". String RuleName The name of the rule that should be set on this Virtual Service. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Force Switch to force the command to execute without a confirmation. SwitchParameter InformationAction ActionPreference InformationVariable String WhatIf Provides a method to see what the command will do without actually executing the command. SwitchParameter Confirm Confirms that the action should be carried out. SwitchParameter Remove-AdcVirtualServerRule VirtualService Specifies the IP Address of the Virtual Service that this rule should be applied to. String VSPort Int32 VSProtocol String VSIndex The index number of the relevant Virtual Service or SubVS. To retrieve the Virtual Service index, run the Get-VirtualService command. Int32 RuleType Specifies if the rule is a pre-processing rule, a response rule, or a request rule. Valid options are "pre", "response", and "request". String RuleName The name of the rule that should be set on this Virtual Service. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String Force Switch to force the command to execute without a confirmation. SwitchParameter InformationAction ActionPreference InformationVariable String WhatIf Provides a method to see what the command will do without actually executing the command. SwitchParameter Confirm Confirms that the action should be carried out. SwitchParameter VirtualService Specifies the IP Address of the Virtual Service that this rule should be applied to. String String VSPort Int32 Int32 VSProtocol String String VSIndex The index number of the relevant Virtual Service or SubVS. To retrieve the Virtual Service index, run the Get-VirtualService command. Int32 Int32 RuleType Specifies if the rule is a pre-processing rule, a response rule, or a request rule. Valid options are "pre", "response", and "request". String String RuleName The name of the rule that should be set on this Virtual Service. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object Force Switch to force the command to execute without a confirmation. SwitchParameter SwitchParameter InformationAction ActionPreference ActionPreference InformationVariable String String WhatIf Provides a method to see what the command will do without actually executing the command. SwitchParameter SwitchParameter Confirm Confirms that the action should be carried out. SwitchParameter SwitchParameter CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String Port Specifies the port on which the Virtual Service accepts connections. int32 int32 Protocol Specifies the communication protocol. Valid options are TCP or UDP. string string RealServer Specifies the Real Server that serves this Virtual Service. string string RSPort Specifies the port on which the Real Server accepts connections for this Virtual Service. int32 int32 -------------------------- Example -------------------------- PS C:\> Remove-AdcVirtualServerRule -RuleName ExampleRule -RuleType pre -VSIndex 2 Example Output: ok Remove-AdcVirtualService Deletes the specified Virtual Service. Remove AdcVirtualService Deletes the specified Virtual Service. Remove-AdcVirtualService VirtualService The IP Address for this Virtual Service. String VSPort The port of the Virtual Service to remove. Int32 VSProtocol The protocol of the Virtual Service to remove. String VSIndex The index (ID) number for this Virtual Service. This can be retrieved by running the Get-AdcVirtualService command, or by checking the Id number on the Virtual Service modify screen. Int32 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Force Switch to force the command to execute without a confirmation. SwitchParameter InformationAction ActionPreference InformationVariable String WhatIf Provides a method to see what the command will do without actually executing the command. SwitchParameter Confirm Confirms that the action should be carried out. SwitchParameter Remove-AdcVirtualService VirtualService The IP Address for this Virtual Service. String VSPort The port of the Virtual Service to remove. Int32 VSProtocol The protocol of the Virtual Service to remove. String VSIndex The index (ID) number for this Virtual Service. This can be retrieved by running the Get-AdcVirtualService command, or by checking the Id number on the Virtual Service modify screen. Int32 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String Force Switch to force the command to execute without a confirmation. SwitchParameter InformationAction ActionPreference InformationVariable String WhatIf Provides a method to see what the command will do without actually executing the command. SwitchParameter Confirm Confirms that the action should be carried out. SwitchParameter Remove-AdcVirtualService VirtualService The IP Address for this Virtual Service. String VSPort The port of the Virtual Service to remove. Int32 VSProtocol The protocol of the Virtual Service to remove. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Force Switch to force the command to execute without a confirmation. SwitchParameter InformationAction ActionPreference InformationVariable String WhatIf Provides a method to see what the command will do without actually executing the command. SwitchParameter Confirm Confirms that the action should be carried out. SwitchParameter Remove-AdcVirtualService VSIndex The index (ID) number for this Virtual Service. This can be retrieved by running the Get-AdcVirtualService command, or by checking the Id number on the Virtual Service modify screen. Int32 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Force Switch to force the command to execute without a confirmation. SwitchParameter InformationAction ActionPreference InformationVariable String WhatIf Provides a method to see what the command will do without actually executing the command. SwitchParameter Confirm Confirms that the action should be carried out. SwitchParameter VirtualService The IP Address for this Virtual Service. String String VSPort The port of the Virtual Service to remove. Int32 Int32 VSProtocol The protocol of the Virtual Service to remove. String String VSIndex The index (ID) number for this Virtual Service. This can be retrieved by running the Get-AdcVirtualService command, or by checking the Id number on the Virtual Service modify screen. Int32 Int32 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object Force Switch to force the command to execute without a confirmation. SwitchParameter SwitchParameter InformationAction ActionPreference ActionPreference InformationVariable String String WhatIf Provides a method to see what the command will do without actually executing the command. SwitchParameter SwitchParameter Confirm Confirms that the action should be carried out. SwitchParameter SwitchParameter CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String Port Specifies the port on which this Virtual Service accepts connections. int32 int32 Protocol Specifies the communication protocol. Valid options are TCP or UDP. string string -------------------------- Example -------------------------- PS C:\> Remove-AdcVirtualService -Port 80 -Protocol tcp -VirtualService 10.11.0.234 Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Remove-AdcVirtualServiceResponseBodyRule Remove AdcVirtualServiceResponseBodyRule Remove-AdcVirtualServiceResponseBodyRule VSIndex Int32 RuleName String LoadBalancer String LBPort Int32 Credential Object Force SwitchParameter InformationAction ActionPreference InformationVariable String WhatIf SwitchParameter Confirm SwitchParameter Remove-AdcVirtualServiceResponseBodyRule VSIndex Int32 RuleName String LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String Force SwitchParameter InformationAction ActionPreference InformationVariable String WhatIf SwitchParameter Confirm SwitchParameter VSIndex Int32 Int32 RuleName String String LoadBalancer String String LBPort Int32 Int32 Credential Object Object Force SwitchParameter SwitchParameter InformationAction ActionPreference ActionPreference InformationVariable String String WhatIf SwitchParameter SwitchParameter Confirm SwitchParameter SwitchParameter CertificateStoreLocation String String SubjectCN String String Remove-AdcVirtualServiceRule Remove a content rule that is assigned to a Virtual Service. Remove AdcVirtualServiceRule This command removes the specified rule from the specified Virtual Service. Remove-AdcVirtualServiceRule VirtualService The address of the Virtual Service to remove the rule from. String VSPort The port number of the Virtual Service to remove the rule from. Int32 VSProtocol The protocol of the Virtual Service to remove the rule from. String VSIndex The index number of the Virtual Service to remove the rule from. Int32 RuleType The type of rule to be removed: pre response request String RuleName The name of the rule to be removed. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Force Enable this parameter to force the command to execute without a confirmation. SwitchParameter InformationAction ActionPreference InformationVariable String WhatIf Enable this parameter to see what the command will do without actually executing the command. SwitchParameter Confirm Confirms that the action should be carried out. SwitchParameter Remove-AdcVirtualServiceRule VirtualService The address of the Virtual Service to remove the rule from. String VSPort The port number of the Virtual Service to remove the rule from. Int32 VSProtocol The protocol of the Virtual Service to remove the rule from. String VSIndex The index number of the Virtual Service to remove the rule from. Int32 RuleType The type of rule to be removed: pre response request String RuleName The name of the rule to be removed. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String Force Enable this parameter to force the command to execute without a confirmation. SwitchParameter InformationAction ActionPreference InformationVariable String WhatIf Enable this parameter to see what the command will do without actually executing the command. SwitchParameter Confirm Confirms that the action should be carried out. SwitchParameter VirtualService The address of the Virtual Service to remove the rule from. String String VSPort The port number of the Virtual Service to remove the rule from. Int32 Int32 VSProtocol The protocol of the Virtual Service to remove the rule from. String String VSIndex The index number of the Virtual Service to remove the rule from. Int32 Int32 RuleType The type of rule to be removed: pre response request String String RuleName The name of the rule to be removed. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object Force Enable this parameter to force the command to execute without a confirmation. SwitchParameter SwitchParameter InformationAction ActionPreference ActionPreference InformationVariable String String WhatIf Enable this parameter to see what the command will do without actually executing the command. SwitchParameter SwitchParameter Confirm Confirms that the action should be carried out. SwitchParameter SwitchParameter CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Remove-AdcVirtualServiceRule -RuleName ExampleRule -RuleType pre -VirtualService 10.154.11.181 -VSPort 443 -VSProtocol tcp Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Remove-AdcVsWafRule Remove a Web Application Firewall (WAF) rule from a Virtual Service. Remove AdcVsWafRule This command removes the specified WAF rule from the Virtual Service. Remove-AdcVsWafRule VS The address of the Virtual Service. String VSPort The port of the Virtual Service. String VSProtocol The protocol of the Virtual Service. String Rule The <RuleName> must be preceded with the relevant letter or word and a forward slash. The letter/word used depends on the type of rule being removed: C or Custom Z or ApplicationGeneric A or ApplicationSpecific G or Generic This is case sensitive. The letter/word needs to be in in the correct case for the command to work. Multiple rules can be removed in the same command by separating them with a space (or %20). String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Remove-AdcVsWafRule VS The address of the Virtual Service. String VSPort The port of the Virtual Service. String VSProtocol The protocol of the Virtual Service. String Rule The <RuleName> must be preceded with the relevant letter or word and a forward slash. The letter/word used depends on the type of rule being removed: C or Custom Z or ApplicationGeneric A or ApplicationSpecific G or Generic This is case sensitive. The letter/word needs to be in in the correct case for the command to work. Multiple rules can be removed in the same command by separating them with a space (or %20). String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String VS The address of the Virtual Service. String String VSPort The port of the Virtual Service. String String VSProtocol The protocol of the Virtual Service. String String Rule The <RuleName> must be preceded with the relevant letter or word and a forward slash. The letter/word used depends on the type of rule being removed: C or Custom Z or ApplicationGeneric A or ApplicationSpecific G or Generic This is case sensitive. The letter/word needs to be in in the correct case for the command to work. Multiple rules can be removed in the same command by separating them with a space (or %20). String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Remove-AdcVsWafRule -Rule G/ip_reputation -VS 10.35.47.16 -VSPort 80 -VSProtocol tcp Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Remove-BondedInterface WARNING: This function is deprecated. Use the following command instead: Remove-NetworkBondedInterface Remove BondedInterface WARNING: This function is deprecated. Use the following command instead: Remove-NetworkBondedInterface Remove-BondedInterface InterfaceID The ID of the interface that has the bond. Int16 BondID The ID of the bonded interface to be removed. Int16 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Remove-BondedInterface InterfaceID The ID of the interface that has the bond. Int16 BondID The ID of the bonded interface to be removed. Int16 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String InterfaceID The ID of the interface that has the bond. Int16 Int16 BondID The ID of the bonded interface to be removed. Int16 Int16 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String -------------------------- Example -------------------------- PS C:\> Remove-BondedInterface –BondID <BondID> –InterfaceID <InterfaceID> Example Output: Remove-Certificate WARNING: This function is deprecated. Use the following command instead: Remove-TlsCertificate Remove Certificate WARNING: This function is deprecated. Use the following command instead: Remove-TlsCertificate Remove-Certificate Name String LoadBalancer String LBPort Int32 Credential Object Force SwitchParameter InformationAction ActionPreference InformationVariable String WhatIf SwitchParameter Confirm SwitchParameter Remove-Certificate Name String LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String Force SwitchParameter InformationAction ActionPreference InformationVariable String WhatIf SwitchParameter Confirm SwitchParameter Name String String LoadBalancer String String LBPort Int32 Int32 Credential Object Object Force SwitchParameter SwitchParameter InformationAction ActionPreference ActionPreference InformationVariable String String WhatIf SwitchParameter SwitchParameter Confirm SwitchParameter SwitchParameter CertificateStoreLocation String String SubjectCN String String Remove-ClusterNode Deletes a node from a cluster. Remove ClusterNode Deletes a node from a cluster. Remove-ClusterNode NodeId The ID number of the node to be deleted. The ID of the node can be found in the ID column in the Cluster Control screen in the LoadMaster WUI. Int32 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Remove-ClusterNode NodeId The ID number of the node to be deleted. The ID of the node can be found in the ID column in the Cluster Control screen in the LoadMaster WUI. Int32 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String NodeId The ID number of the node to be deleted. The ID of the node can be found in the ID column in the Cluster Control screen in the LoadMaster WUI. Int32 Int32 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Remove-ClusterNode -NodeId 2 Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. RemoveCountry WARNING: This function is deprecated. Use the following command instead: Remove-GeoFQDNSiteCountry WARNING: This function is deprecated. Use the following command instead: Remove-GeoFQDNSiteCountry RemoveCountry FQDN String SiteAddress String CountryCode String IsContinent String CustomLocation String LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String RemoveCountry FQDN String SiteAddress String CountryCode String IsContinent String CustomLocation String LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String FQDN String String SiteAddress String String CountryCode String String IsContinent String String CustomLocation String String LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String Remove-GeoCluster Allows you to delete an existing GEO cluster. Remove GeoCluster Allows you to delete an existing GEO cluster. Remove-GeoCluster ClusterIp The IP address of the cluster. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Remove-GeoCluster ClusterIp The IP address of the cluster. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String ClusterIp The IP address of the cluster. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Remove-GeoCluster –IP 10.34.52.56 Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Remove-GeoCustomLocation Removes an existing custom location. Remove GeoCustomLocation Removes an existing custom location. Remove-GeoCustomLocation Location The name of the location to remove. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Remove-GeoCustomLocation Location The name of the location to remove. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String Location The name of the location to remove. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String clName Specify the name of the custom location to be removed. string string -------------------------- Example -------------------------- PS C:\> Remove-GeoCustomLocation -Location Example Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Remove-GeoDNSSECKeySigningKey Delete the Key Signing Key (KSK) files. Remove GeoDNSSECKeySigningKey Remove the KSK files. Remove-GeoDNSSECKeySigningKey LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Remove-GeoDNSSECKeySigningKey LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Remove-GeoDNSSECKeySigningKey Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Remove-GeoFQDN Allows you to delete an existing GEO FQDN. Remove GeoFQDN Allows you to delete an existing GEO FQDN. Remove-GeoFQDN FQDN The name of the FQDN. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Remove-GeoFQDN FQDN The name of the FQDN. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String FQDN The name of the FQDN. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Remove-GeoFQDN –FQDN ExampleFQDN.com Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Remove-GeoFQDNSiteAddress Allows you to delete an IP address from an FQDN. Remove GeoFQDNSiteAddress Allows you to delete an IP address from an FQDN. Remove-GeoFQDNSiteAddress FQDN The name of the FQDN. String SiteAddress IP address to be deleted from the FQDN. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Remove-GeoFQDNSiteAddress FQDN The name of the FQDN. String SiteAddress IP address to be deleted from the FQDN. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String FQDN The name of the FQDN. String String SiteAddress IP address to be deleted from the FQDN. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Remove-GeoFQDNSiteAddress –FQDN Example.com -IP 10.134.33.3 Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed. Deleted site 10.134.33.3 from FQDN Example.com; Data=} Return Code..: 200 Response.....: Command successfully executed. Deleted site 10.134.33.3 from FQDN Example.com Remove-GeoFQDNSiteCountry Remove a country assignment. Remove GeoFQDNSiteCountry Allows you to remove a country assignment from a mapped IP address. Remove-GeoFQDNSiteCountry FQDN The name of the FQDN. String SiteAddress The address of the map to be modified. String CountryCode Two-letter country code for the country to be unassigned. To specify everywhere as the country, type ALL as the country code and set the IsContinent parameter to yes. String IsContinent Some country codes and continent codes are the same, for example AF could mean Africa or Afghanistan. You must specify in this parameter if the code is for a country or continent. yes – code is for a continent no – code is for a country String CustomLocation The name of an existing custom location. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Remove-GeoFQDNSiteCountry FQDN The name of the FQDN. String SiteAddress The address of the map to be modified. String CountryCode Two-letter country code for the country to be unassigned. To specify everywhere as the country, type ALL as the country code and set the IsContinent parameter to yes. String IsContinent Some country codes and continent codes are the same, for example AF could mean Africa or Afghanistan. You must specify in this parameter if the code is for a country or continent. yes – code is for a continent no – code is for a country String CustomLocation The name of an existing custom location. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String FQDN The name of the FQDN. String String SiteAddress The address of the map to be modified. String String CountryCode Two-letter country code for the country to be unassigned. To specify everywhere as the country, type ALL as the country code and set the IsContinent parameter to yes. String String IsContinent Some country codes and continent codes are the same, for example AF could mean Africa or Afghanistan. You must specify in this parameter if the code is for a country or continent. yes – code is for a continent no – code is for a country String String CustomLocation The name of an existing custom location. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Remove-GeoFQDNSiteCountry -FQDN Example.com -SiteAddress 10.134.33.2 -CountryCode IE -IsContinent no Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed. Country/Continent updated.; Data=} Return Code..: 200 Response.....: Command successfully executed. Country/Continent updated. Remove-GeoIpRange Allows you to delete an entry from the IP range selection criteria list. Remove GeoIpRange Allows you to delete an entry from the IP range selection criteria list. Remove-GeoIpRange IP The IP address of the entry to be deleted. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Remove-GeoIpRange IP The IP address of the entry to be deleted. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String IP The IP address of the entry to be deleted. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Remove-GeoIPRange –IP 10.134.33.2 Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed. IP range deleted; Data=} Return Code..: 200 Response.....: Command successfully executed. IP range deleted Remove-GeoIPRangeCoordinates Allows you to delete the location assigned to an IP address. Remove GeoIPRangeCoordinates Allows you to delete the location assigned to an IP address. Remove-GeoIPRangeCoordinates IP The IP address to be modified. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Remove-GeoIPRangeCoordinates IP The IP address to be modified. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String IP The IP address to be modified. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Remove-GeoIPRangeCoordinates –IP 10.154.11.55 Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed. IP range location updated; Data=} Return Code..: 200 Response.....: Command successfully executed. IP range location updated Remove-GeoIPRangeCountry Allows you to unassign a country from an IP address. Remove GeoIPRangeCountry Allows you to unassign a country from an IP address. Remove-GeoIPRangeCountry IP IP address to remove the country from. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Remove-GeoIPRangeCountry IP IP address to remove the country from. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String IP IP address to remove the country from. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Remove-GeoIPRangeCountry -IP 10.154.11.55 Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed. IP range country updated; Data=} Return Code..: 200 Response.....: Command successfully executed. IP range country updated Remove-GeoIPRangeCustomLocation WARNING: This function is deprecated. Use the following command instead: Remove-GeoIPRangeCountry Remove GeoIPRangeCustomLocation WARNING: This function is deprecated. Use the following command instead: Remove-GeoIPRangeCountry Remove-GeoIPRangeCustomLocation IP String LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String Remove-GeoIPRangeCustomLocation IP String LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String IP String String LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String Remove-GeoIPWhitelist Remove an IP address or network from the whitelist. Remove GeoIPWhitelist Run this command to remove the specified address from the whitelist. The whitelist entries override the blacklist. Remove-GeoIPWhitelist Addr Specify the address to be removed from the user-defined whitelist. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Remove-GeoIPWhitelist Addr Specify the address to be removed from the user-defined whitelist. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String Addr Specify the address to be removed from the user-defined whitelist. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Remove-GeoIPWhitelist -Addr 10.145.33.22 Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed. 10.145.33.22 was successfully removed from GEO ACL white list.; Data=} Return Code..: 200 Response.....: Command successfully executed. 10.145.33.22 was successfully removed from GEO ACL white list. Remove-GlobalPacketFilterACL Removes an address from the global black or white list. Remove GlobalPacketFilterACL Removes a host or network IP address from the global black or white access control list. Note that black and white lists are only enabled when packet filtering is enabled. Remove-GlobalPacketFilterACL Type Specifies the access control list type: "black" or "white". String Address Specifies a host or network IP address to remove from the access control list. The address can be specified in CIDR format. If the CIDR is not specified, the system uses a default of /32. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Remove-GlobalPacketFilterACL Type Specifies the access control list type: "black" or "white". String Address Specifies a host or network IP address to remove from the access control list. The address can be specified in CIDR format. If the CIDR is not specified, the system uses a default of /32. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String Type Specifies the access control list type: "black" or "white". String String Address Specifies a host or network IP address to remove from the access control list. The address can be specified in CIDR format. If the CIDR is not specified, the system uses a default of /32. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Remove-GlobalPacketFilterACL -Address 10.154.11.197 -Type black Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Remove-HostsEntry Deletes a host IP address and host FQDN. Remove HostsEntry Deletes a host IP address and host FQDN. Remove-HostsEntry HostIP Specify the IP address for the entry. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Remove-HostsEntry HostIP Specify the IP address for the entry. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String HostIP Specify the IP address for the entry. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Remove-HostsEntry -HostIP 10.154.11.180 Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Remove-InterfaceAddress WARNING: This function is deprecated. Use the following command instead: Remove-NetworkInterfaceAdditionalAddress Remove InterfaceAddress WARNING: This function is deprecated. Use the following command instead: Remove-NetworkInterfaceAdditionalAddress Remove-InterfaceAddress InterfaceID Int16 Address String LoadBalancer String LBPort Int32 Credential Object Force SwitchParameter InformationAction ActionPreference InformationVariable String WhatIf SwitchParameter Confirm SwitchParameter Remove-InterfaceAddress InterfaceID Int16 Address String LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String Force SwitchParameter InformationAction ActionPreference InformationVariable String WhatIf SwitchParameter Confirm SwitchParameter InterfaceID Int16 Int16 Address String String LoadBalancer String String LBPort Int32 Int32 Credential Object Object Force SwitchParameter SwitchParameter InformationAction ActionPreference ActionPreference InformationVariable String String WhatIf SwitchParameter SwitchParameter Confirm SwitchParameter SwitchParameter CertificateStoreLocation String String SubjectCN String String Remove-IntermediateCertificate WARNING: This function is deprecated. Use the following command instead: Remove-TlsIntermediateCertificate Remove IntermediateCertificate WARNING: This function is deprecated. Use the following command instead: Remove-TlsIntermediateCertificate Remove-IntermediateCertificate Name String LoadBalancer String LBPort Int32 Credential Object Force SwitchParameter InformationAction ActionPreference InformationVariable String WhatIf SwitchParameter Confirm SwitchParameter Remove-IntermediateCertificate Name String LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String Force SwitchParameter InformationAction ActionPreference InformationVariable String WhatIf SwitchParameter Confirm SwitchParameter Name String String LoadBalancer String String LBPort Int32 Int32 Credential Object Object Force SwitchParameter SwitchParameter InformationAction ActionPreference ActionPreference InformationVariable String String WhatIf SwitchParameter SwitchParameter Confirm SwitchParameter SwitchParameter CertificateStoreLocation String String SubjectCN String String RemoveIPCountry WARNING: This function is deprecated. Use the following command instead: Remove-GeoIPRangeCountry WARNING: This function is deprecated. Use the following command instead: Remove-GeoIPRangeCountry RemoveIPCountry IP String LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String RemoveIPCountry IP String LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String IP String String LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String RemoveIPCountryCustom WARNING: This function is deprecated. Use the following command instead: Remove-GeoIPRangeCountry WARNING: This function is deprecated. Use the following command instead: Remove-GeoIPRangeCountry RemoveIPCountryCustom IP String LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String RemoveIPCountryCustom IP String LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String IP String String LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String Remove-LdapEndpoint Delete an existing LDAP endpoint. Remove LdapEndpoint These LDAP endpoints may be used in three different areas: • Health checks • SSO domains • WUI authentication Remove-LdapEndpoint Name The name of the LDAP endpoint to be deleted. String LoadBalancer The IP address of the KEMP LoadMaster that you are directing the command to. This can be set globally by using the Initialize-LoadBalancer command, but can be overridden on each individual command by using this parameter. String LBPort The port of the load balancer. Int32 Credential Specifies a user account that has permission to administer the load balancer. You can either enter a username for the load balancer or provide a PSCredential object, such as an object that is returned by the Get-Credential cmdlet. When you type a username, you are prompted for a password. Object InformationAction ActionPreference InformationVariable String Remove-LdapEndpoint Name The name of the LDAP endpoint to be deleted. String LoadBalancer The IP address of the KEMP LoadMaster that you are directing the command to. This can be set globally by using the Initialize-LoadBalancer command, but can be overridden on each individual command by using this parameter. String LBPort The port of the load balancer. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. String InformationAction ActionPreference InformationVariable String Name The name of the LDAP endpoint to be deleted. String String LoadBalancer The IP address of the KEMP LoadMaster that you are directing the command to. This can be set globally by using the Initialize-LoadBalancer command, but can be overridden on each individual command by using this parameter. String String LBPort The port of the load balancer. Int32 Int32 Credential Specifies a user account that has permission to administer the load balancer. You can either enter a username for the load balancer or provide a PSCredential object, such as an object that is returned by the Get-Credential cmdlet. When you type a username, you are prompted for a password. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. String String It is not possible to delete an LDAP endpoint that is currently in use. -------------------------- Example -------------------------- PS C:\> Remove-LdapEndpoint -Name ExampleLDAPEndpoint Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Remove-LmAddon Deletes an Add-on pack Remove LmAddon Add-on packs can be deleted by running the Remove-LmAddon command. Remove-LmAddon Name The name of the add-on pack. The names of existing add-on packs can be seen by running the ListAddons command. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Remove-LmAddon Name The name of the add-on pack. The names of existing add-on packs can be seen by running the ListAddons command. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String Name The name of the add-on pack. The names of existing add-on packs can be seen by running the ListAddons command. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Remove-LmAddon -Name Akamai Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Remove-LmIPConnectionLimit Allows you to delete an IP address limiter. Remove LmIPConnectionLimit Allows you to delete an IP address limiter. Remove-LmIPConnectionLimit L7addr The IP address to be deleted. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Remove-LmIPConnectionLimit L7addr The IP address to be deleted. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String L7addr The IP address to be deleted. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Remove-LmIPConnectionLimit -L7addr 10.10.10.10 Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Remove-LmVpnConnection Deletes an existing Virtual Private Network (VPN) connection. Remove LmVpnConnection Removes the specified VPN connection. Remove-LmVpnConnection Name The name of the VPN. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Remove-LmVpnConnection Name The name of the VPN. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String Name The name of the VPN. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Remove-LmVpnConnection -Name ExampleVPNConnection Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Remove-NetworkBondedInterface Remove a bonded interface. Remove NetworkBondedInterface Unlink the specified interface from the bonded interface. Remove-NetworkBondedInterface InterfaceID The ID of the interface that has the bond. Int16 BondID The ID of the interface to be unlinked. Int16 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Remove-NetworkBondedInterface InterfaceID The ID of the interface that has the bond. Int16 BondID The ID of the interface to be unlinked. Int16 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String InterfaceID The ID of the interface that has the bond. Int16 Int16 BondID The ID of the interface to be unlinked. Int16 Int16 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Remove-NetworkBondedInterface –InterfaceID 1 Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Data field...: @{Interface=} Id : 1 IPAddress : NBondMembers : 1 BondMembers : @{RealInterface=1} Mode : 802.3ad InterfaceType : Bonded GeoTrafficEnable : no DefaultInterface : no Remove-NetworkInterfaceAdditionalAddress Remove an additional address from an interface. Remove NetworkInterfaceAdditionalAddress Run this command to remove an existing additional address from an interface. Remove-NetworkInterfaceAdditionalAddress InterfaceID The ID of the interface to remove the additional address from. Int16 Address The address to be removed, in the format <IPAddress>/<CIDR>. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Force Enable this parameter to force the command to execute without a confirmation. SwitchParameter InformationAction ActionPreference InformationVariable String WhatIf Enable this parameter to see what the command will do without actually executing the command. SwitchParameter Confirm Confirms that the action should be carried out. SwitchParameter Remove-NetworkInterfaceAdditionalAddress InterfaceID The ID of the interface to remove the additional address from. Int16 Address The address to be removed, in the format <IPAddress>/<CIDR>. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String Force Enable this parameter to force the command to execute without a confirmation. SwitchParameter InformationAction ActionPreference InformationVariable String WhatIf Enable this parameter to see what the command will do without actually executing the command. SwitchParameter Confirm Confirms that the action should be carried out. SwitchParameter InterfaceID The ID of the interface to remove the additional address from. Int16 Int16 Address The address to be removed, in the format <IPAddress>/<CIDR>. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object Force Enable this parameter to force the command to execute without a confirmation. SwitchParameter SwitchParameter InformationAction ActionPreference ActionPreference InformationVariable String String WhatIf Enable this parameter to see what the command will do without actually executing the command. SwitchParameter SwitchParameter Confirm Confirms that the action should be carried out. SwitchParameter SwitchParameter CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Remove-NetworkInterfaceAdditionalAddress -Address 10.154.11.22/16 Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Remove-NetworkRoute Removes a route. Remove NetworkRoute Removes a route. Remove-NetworkRoute Destination The destination network that should be removed from the routing table. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Remove-NetworkRoute Destination The destination network that should be removed from the routing table. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String Destination The destination network that should be removed from the routing table. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Remove-NetworkRoute -Destination 10.154.11.33 Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Data field...: @{Route=} Destination : 10.154.11.24/16 Gateway : 10.154.11.44 Remove-NetworkVLAN Allows you to remove a Virtual LAN. Remove NetworkVLAN Allows you to remove a Virtual LAN. Remove-NetworkVLAN InterfaceID The ID of the interface that should be removed from the VLAN. Int16 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Remove-NetworkVLAN InterfaceID The ID of the interface that should be removed from the VLAN. Int16 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String InterfaceID The ID of the interface that should be removed from the VLAN. Int16 Int16 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Remove-NetworkVLAN -InterfaceID 2 Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Data field...: Remove-NetworkVxLAN Deletes the specified VXLAN. Remove NetworkVxLAN Deletes the specified VXLAN. Remove-NetworkVxLAN InterfaceID The ID of the interface. Int16 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Remove-NetworkVxLAN InterfaceID The ID of the interface. Int16 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String InterfaceID The ID of the interface. Int16 Int16 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Remove-NetworkVxLAN -InterfaceID 2 Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Remove-NoCacheExtension WARNING: This function is deprecated. Use the following command instead: Remove-AdcHttpCacheException Remove NoCacheExtension WARNING: This function is deprecated. Use the following command instead: Remove-AdcHttpCacheException Remove-NoCacheExtension Extension String[] LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String Remove-NoCacheExtension Extension String[] LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String Extension String[] String[] LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String Remove-NoCompressExtension WARNING: This function is deprecated. Use the following command instead: Remove-AdcHttpCompressionException Remove NoCompressExtension WARNING: This function is deprecated. Use the following command instead: Remove-AdcHttpCompressionException Remove-NoCompressExtension Extension String[] LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String Remove-NoCompressExtension Extension String[] LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String Extension String[] String[] LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String Remove-RealServer WARNING: This function is deprecated. Use the following command instead: Remove-AdcRealServer Remove RealServer WARNING: This function is deprecated. Use the following command instead: Remove-AdcRealServer Remove-RealServer VirtualService String VSPort Int32 VSProtocol String VSIndex Int32 RealServer String RealServerPort Int32 RSIndex Int32 LoadBalancer String LBPort Int32 Credential Object Force SwitchParameter InformationAction ActionPreference InformationVariable String WhatIf SwitchParameter Confirm SwitchParameter Remove-RealServer VirtualService String VSPort Int32 VSProtocol String VSIndex Int32 RealServer String RealServerPort Int32 RSIndex Int32 LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String Force SwitchParameter InformationAction ActionPreference InformationVariable String WhatIf SwitchParameter Confirm SwitchParameter VirtualService String String VSPort Int32 Int32 VSProtocol String String VSIndex Int32 Int32 RealServer String String RealServerPort Int32 Int32 RSIndex Int32 Int32 LoadBalancer String String LBPort Int32 Int32 Credential Object Object Force SwitchParameter SwitchParameter InformationAction ActionPreference ActionPreference InformationVariable String String WhatIf SwitchParameter SwitchParameter Confirm SwitchParameter SwitchParameter CertificateStoreLocation String String SubjectCN String String Remove-RealServerRule WARNING: This function is deprecated. Use the following command instead: Remove-AdcRealServerRule Remove RealServerRule WARNING: This function is deprecated. Use the following command instead: Remove-AdcRealServerRule Remove-RealServerRule VirtualService String VSPort Int32 VSProtocol String VSIndex Int32 RealServer String RSPort Int32 RSIndex Int32 RuleName String LoadBalancer String LBPort Int32 Credential Object Force SwitchParameter InformationAction ActionPreference InformationVariable String WhatIf SwitchParameter Confirm SwitchParameter Remove-RealServerRule VirtualService String VSPort Int32 VSProtocol String VSIndex Int32 RealServer String RSPort Int32 RSIndex Int32 RuleName String LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String Force SwitchParameter InformationAction ActionPreference InformationVariable String WhatIf SwitchParameter Confirm SwitchParameter VirtualService String String VSPort Int32 Int32 VSProtocol String String VSIndex Int32 Int32 RealServer String String RSPort Int32 Int32 RSIndex Int32 Int32 RuleName String String LoadBalancer String String LBPort Int32 Int32 Credential Object Object Force SwitchParameter SwitchParameter InformationAction ActionPreference ActionPreference InformationVariable String String WhatIf SwitchParameter SwitchParameter Confirm SwitchParameter SwitchParameter CertificateStoreLocation String String SubjectCN String String Remove-Route WARNING: This function is deprecated. Use the following command instead: Remove-NetworkRoute Remove Route WARNING: This function is deprecated. Use the following command instead: Remove-NetworkRoute Remove-Route Destination String LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String Remove-Route Destination String LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String Destination String String LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String Remove-Rule WARNING: This function is deprecated. Use the following command instead: Remove-AdcContentRule Remove Rule WARNING: This function is deprecated. Use the following command instead: Remove-AdcContentRule Remove-Rule RuleName String LoadBalancer String LBPort Int32 Credential Object Force SwitchParameter InformationAction ActionPreference InformationVariable String WhatIf SwitchParameter Confirm SwitchParameter Remove-Rule RuleName String LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String Force SwitchParameter InformationAction ActionPreference InformationVariable String WhatIf SwitchParameter Confirm SwitchParameter RuleName String String LoadBalancer String String LBPort Int32 Int32 Credential Object Object Force SwitchParameter SwitchParameter InformationAction ActionPreference ActionPreference InformationVariable String String WhatIf SwitchParameter SwitchParameter Confirm SwitchParameter SwitchParameter CertificateStoreLocation String String SubjectCN String String Remove-SdnController Deletes an SDN controller from the LoadMaster. Remove SdnController Deletes an SDN controller from the LoadMaster. Remove-SdnController Clid The unique ID of the cluster that the SDN controller is a member of. Int32 Cid The ID number of the SDN controller. Int32 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Remove-SdnController Clid The unique ID of the cluster that the SDN controller is a member of. Int32 Cid The ID number of the SDN controller. Int32 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String Clid The unique ID of the cluster that the SDN controller is a member of. Int32 Int32 Cid The ID number of the SDN controller. Int32 Int32 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String Either the Cluster ID (Clid) or the Controller ID (Cid) must be specified when running this command. -------------------------- Example -------------------------- PS C:\> Remove-SdnController -Clid 1 -Cid 1 Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Remove-SecUser Allows you to delete a local user. Remove SecUser Allows you to delete a local user. Remove-SecUser User Username of the relevant user. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Force Enable this parameter to force the command to execute without a confirmation. SwitchParameter InformationAction ActionPreference InformationVariable String WhatIf Enable this parameter to see what the command will do without actually executing the command. SwitchParameter Confirm Confirms that the action should be carried out. SwitchParameter Remove-SecUser User Username of the relevant user. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String Force Enable this parameter to force the command to execute without a confirmation. SwitchParameter InformationAction ActionPreference InformationVariable String WhatIf Enable this parameter to see what the command will do without actually executing the command. SwitchParameter Confirm Confirms that the action should be carried out. SwitchParameter User Username of the relevant user. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object Force Enable this parameter to force the command to execute without a confirmation. SwitchParameter SwitchParameter InformationAction ActionPreference ActionPreference InformationVariable String String WhatIf Enable this parameter to see what the command will do without actually executing the command. SwitchParameter SwitchParameter Confirm Confirms that the action should be carried out. SwitchParameter SwitchParameter CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Remove-SecUser -User ExampleUser Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Remove-SecUserCertificate Delete an existing user certificate. Remove SecUserCertificate Delete an existing user certificate. Remove-SecUserCertificate User The username of the user to delete the certificate for. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Remove-SecUserCertificate User The username of the user to delete the certificate for. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String User The username of the user to delete the certificate for. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Remove-SecUserCertificate -User Example Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Remove-SSODomain Deletes the specified SSO domain. Remove SSODomain Deletes the specified SSO domain. Remove-SSODomain Domain The domain to be removed from the SSO Domain list. This parameter is required. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Force Switch to force the command to execute without a confirmation. SwitchParameter InformationAction ActionPreference InformationVariable String WhatIf Provides a method to see what the command will do without actually executing the command. SwitchParameter Confirm Confirms that the action should be carried out. SwitchParameter Remove-SSODomain Domain The domain to be removed from the SSO Domain list. This parameter is required. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String Force Switch to force the command to execute without a confirmation. SwitchParameter InformationAction ActionPreference InformationVariable String WhatIf Provides a method to see what the command will do without actually executing the command. SwitchParameter Confirm Confirms that the action should be carried out. SwitchParameter Domain The domain to be removed from the SSO Domain list. This parameter is required. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object Force Switch to force the command to execute without a confirmation. SwitchParameter SwitchParameter InformationAction ActionPreference ActionPreference InformationVariable String String WhatIf Provides a method to see what the command will do without actually executing the command. SwitchParameter SwitchParameter Confirm Confirms that the action should be carried out. SwitchParameter SwitchParameter CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Remove-SSODomain -Domain example3.com Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed (Domain "example3.com" deleted); Data=} Return Code..: 200 Response.....: Command successfully executed (Domain "example3.com" deleted) Remove-Template Allows you to remove a template from the LoadMaster. Remove Template Allows you to remove a template from the LoadMaster. Remove-Template Name The name of the template as it appears in the Name column in the LoadMaster. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Remove-Template Name The name of the template as it appears in the Name column in the LoadMaster. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String Name The name of the template as it appears in the Name column in the LoadMaster. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Remove-Template -Name "Exchange 2013 IMAP" Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Remove-TlsCertificate Allows you to remove a certificate from the LoadMaster. Remove TlsCertificate Allows you to remove a certificate from the LoadMaster. Remove-TlsCertificate Name The name of the certificate to be removed from the LoadMaster. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Force Enable this parameter to force the command to execute without a confirmation. SwitchParameter InformationAction ActionPreference InformationVariable String WhatIf Provides a method to see what the command will do without actually executing the command. SwitchParameter Confirm Confirms that the action should be carried out. SwitchParameter Remove-TlsCertificate Name The name of the certificate to be removed from the LoadMaster. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String Force Enable this parameter to force the command to execute without a confirmation. SwitchParameter InformationAction ActionPreference InformationVariable String WhatIf Provides a method to see what the command will do without actually executing the command. SwitchParameter Confirm Confirms that the action should be carried out. SwitchParameter Name The name of the certificate to be removed from the LoadMaster. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object Force Enable this parameter to force the command to execute without a confirmation. SwitchParameter SwitchParameter InformationAction ActionPreference ActionPreference InformationVariable String String WhatIf Provides a method to see what the command will do without actually executing the command. SwitchParameter SwitchParameter Confirm Confirms that the action should be carried out. SwitchParameter SwitchParameter CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String It is not possible to delete a certificate which is assigned to a Virtual Service. Un-assign the certificate from any Virtual Services before deleting. -------------------------- Example -------------------------- PS C:\> Remove-TlsCertificate -Name testcert Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Remove-TlsCipherSet Delete a custom cipher set. Remove TlsCipherSet Deletes an existing custom cipher set. A custom cipher set cannot be deleted if it is assigned to any Virtual Services. Remove-TlsCipherSet Name The name of the cipher set. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Remove-TlsCipherSet Name The name of the cipher set. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String Name The name of the cipher set. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Remove-TlsCipherSet -Name ExampleCipherSet Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Remove-TlsIntermediateCertificate Allows you to remove a certificate from the LoadMaster. Remove TlsIntermediateCertificate Allows you to remove a certificate from the LoadMaster. Remove-TlsIntermediateCertificate Name The name of the intermediate certificate to remove. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Force Enable this parameter to force the command to execute without a confirmation. SwitchParameter InformationAction ActionPreference InformationVariable String WhatIf Enable this parameter to see what the command will do without actually executing the command. SwitchParameter Confirm A switch which confirms that the action should be carried out. SwitchParameter Remove-TlsIntermediateCertificate Name The name of the intermediate certificate to remove. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String Force Enable this parameter to force the command to execute without a confirmation. SwitchParameter InformationAction ActionPreference InformationVariable String WhatIf Enable this parameter to see what the command will do without actually executing the command. SwitchParameter Confirm A switch which confirms that the action should be carried out. SwitchParameter Name The name of the intermediate certificate to remove. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object Force Enable this parameter to force the command to execute without a confirmation. SwitchParameter SwitchParameter InformationAction ActionPreference ActionPreference InformationVariable String String WhatIf Enable this parameter to see what the command will do without actually executing the command. SwitchParameter SwitchParameter Confirm A switch which confirms that the action should be carried out. SwitchParameter SwitchParameter CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Remove-TlsIntermediateCertificate -Name testcert Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Remove-VirtualServerRule WARNING: This function is deprecated. Use the following command instead: Remove-AdcVirtualServiceRule Remove VirtualServerRule WARNING: This function is deprecated. Use the following command instead: Remove-AdcVirtualServiceRule Remove-VirtualServerRule VirtualService String VSPort Int32 VSProtocol String VSIndex Int32 RuleType String RuleName String LoadBalancer String LBPort Int32 Credential Object Force SwitchParameter InformationAction ActionPreference InformationVariable String WhatIf SwitchParameter Confirm SwitchParameter Remove-VirtualServerRule VirtualService String VSPort Int32 VSProtocol String VSIndex Int32 RuleType String RuleName String LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String Force SwitchParameter InformationAction ActionPreference InformationVariable String WhatIf SwitchParameter Confirm SwitchParameter VirtualService String String VSPort Int32 Int32 VSProtocol String String VSIndex Int32 Int32 RuleType String String RuleName String String LoadBalancer String String LBPort Int32 Int32 Credential Object Object Force SwitchParameter SwitchParameter InformationAction ActionPreference ActionPreference InformationVariable String String WhatIf SwitchParameter SwitchParameter Confirm SwitchParameter SwitchParameter CertificateStoreLocation String String SubjectCN String String Remove-VirtualService WARNING: This function is deprecated. Use the following command instead: Remove-AdcVirtualService Remove VirtualService WARNING: This function is deprecated. Use the following command instead: Remove-AdcVirtualService Remove-VirtualService VirtualService String VSPort Int32 VSProtocol String VSIndex Int32 LoadBalancer String LBPort Int32 Credential Object Force SwitchParameter InformationAction ActionPreference InformationVariable String WhatIf SwitchParameter Confirm SwitchParameter Remove-VirtualService VirtualService String VSPort Int32 VSProtocol String VSIndex Int32 LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String Force SwitchParameter InformationAction ActionPreference InformationVariable String WhatIf SwitchParameter Confirm SwitchParameter Remove-VirtualService VirtualService String VSPort Int32 VSProtocol String LoadBalancer String LBPort Int32 Force SwitchParameter InformationAction ActionPreference InformationVariable String WhatIf SwitchParameter Confirm SwitchParameter Remove-VirtualService VSIndex Int32 LoadBalancer String LBPort Int32 Force SwitchParameter InformationAction ActionPreference InformationVariable String WhatIf SwitchParameter Confirm SwitchParameter VirtualService String String VSPort Int32 Int32 VSProtocol String String VSIndex Int32 Int32 LoadBalancer String String LBPort Int32 Int32 Credential Object Object Force SwitchParameter SwitchParameter InformationAction ActionPreference ActionPreference InformationVariable String String WhatIf SwitchParameter SwitchParameter Confirm SwitchParameter SwitchParameter CertificateStoreLocation String String SubjectCN String String Remove-VLan WARNING: This function is deprecated. Use the following command instead: Remove-NetworkVLAN Remove VLan WARNING: This function is deprecated. Use the following command instead: Remove-NetworkVLAN Remove-VLan InterfaceID Int16 LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String Remove-VLan InterfaceID Int16 LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String InterfaceID Int16 Int16 LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String Remove-VSPacketFilterACL Removes an address from the black or white list for a Virtual Service. Remove VSPacketFilterACL Removes a host or network IP address from the black or white access control list for a specific Virtual Service. Note that black and white lists are only enabled when packet filtering is enabled. Remove-VSPacketFilterACL VirtualService Specifies the Virtual Service IP address. String VSPort Specifies the Virtual Service port number. Int32 VSProtocol Specifies the Virtual Service protocol. String Type Specify the type of list: - black: blocked addresses - white: allowed addresses Note: This is case sensitive – the type value should be in lowercase. String AclAddress Specifies a host or network IP address to remove from the access control list. The address can be specified in CIDR format. If the CIDR is not specified, the system uses a default of /32. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Remove-VSPacketFilterACL VirtualService Specifies the Virtual Service IP address. String VSPort Specifies the Virtual Service port number. Int32 VSProtocol Specifies the Virtual Service protocol. String Type Specify the type of list: - black: blocked addresses - white: allowed addresses Note: This is case sensitive – the type value should be in lowercase. String AclAddress Specifies a host or network IP address to remove from the access control list. The address can be specified in CIDR format. If the CIDR is not specified, the system uses a default of /32. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String VirtualService Specifies the Virtual Service IP address. String String VSPort Specifies the Virtual Service port number. Int32 Int32 VSProtocol Specifies the Virtual Service protocol. String String Type Specify the type of list: - black: blocked addresses - white: allowed addresses Note: This is case sensitive – the type value should be in lowercase. String String AclAddress Specifies a host or network IP address to remove from the access control list. The address can be specified in CIDR format. If the CIDR is not specified, the system uses a default of /32. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Remove-VSPacketFilterACL -AclAddress 10.134.33.2 -Type black -VirtualService 10.35.47.16 -VSPort 80 -VSProtocol tcp Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Remove-VxLan WARNING: This function is deprecated. Use the following command instead: Remove-NetworkVxLAN Remove VxLan WARNING: This function is deprecated. Use the following command instead: Remove-NetworkVxLAN Remove-VxLan InterfaceID Int16 LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String Remove-VxLan InterfaceID Int16 LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String InterfaceID Int16 Int16 LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String Request-LicenseOffline Initially license the LoadMaster using the offline licensing method. Request LicenseOffline A BLOB is needed to license the LoadMaster using the offline method. Request-LicenseOffline Path The BLOB is emailed to you when requested. Each time a license is updated a new BLOB is needed. The BLOB is the body of text in the email from the word begin to the word end. The BLOB must be copied and pasted into a text file. If the BLOB file is in the current directory, you only need to specify the filename. If it is in a different directory, please specify the path in addition to the filename. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Path The BLOB is emailed to you when requested. Each time a license is updated a new BLOB is needed. The BLOB is the body of text in the email from the word begin to the word end. The BLOB must be copied and pasted into a text file. If the BLOB file is in the current directory, you only need to specify the filename. If it is in a different directory, please specify the path in addition to the filename. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String Certificate-based authentication cannot be used to run this command because this command is used before the LoadMaster is licensed. -------------------------- Example -------------------------- PS C:\> Request-LicenseOffline -Path c:\t\test.txt Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Request-LicenseOnline License the LoadMaster using the online method. Request LicenseOnline Cause the LoadMaster to query the KEMP licensing system for a license. Request-LicenseOnline LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object KempId The KEMP ID is the email address which was used when registering for a KEMP ID. String Password The password of the KEMP ID account. String OrderId The Orderid parameter is only needed for Virtual LoadMasters. The Order ID is provided by KEMP after a license is purchased. String LicenseTypeId The ID of the license type to be applied. To retrieve a list of available IDs, run the Get-LicenseType command. String http_proxy Specify the HTTP(S) proxy server and port the LoadMaster will use to access the internet. String InformationAction ActionPreference InformationVariable String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object KempId The KEMP ID is the email address which was used when registering for a KEMP ID. String String Password The password of the KEMP ID account. String String OrderId The Orderid parameter is only needed for Virtual LoadMasters. The Order ID is provided by KEMP after a license is purchased. String String LicenseTypeId The ID of the license type to be applied. To retrieve a list of available IDs, run the Get-LicenseType command. String String http_proxy Specify the HTTP(S) proxy server and port the LoadMaster will use to access the internet. String String InformationAction ActionPreference ActionPreference InformationVariable String String Certificate-based authentication cannot be used to run this command because this command is used before the LoadMaster is licensed. -------------------------- Example -------------------------- PS C:\> Request-LicenseOnline -KempId jbloggs@kemptechnologies.com -Password examplepassword -LoadBalancer 10.154.11.60 Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Request-LicenseOnPremise Use Local Activation to license the LoadMaster via KEMP 360 Central. Request LicenseOnPremise Specify the KEMP 360 Central details in the parameters in order to license the LoadMaster using Local Activation. Request-LicenseOnPremise aslipaddr The IP address of the KEMP360 Central machine to be used for activation. String aslname The hostname of the KEMP360 Central machine to be used for activation. String aslport The port to contact KEMP360 Central on. Int32 LicenseTypeId Specify the LicenseTypeId of the license to activate. To retrieve a list of license types and IDs, run the Get-AslLicenseType command. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Request-LicenseOnPremise aslipaddr The IP address of the KEMP360 Central machine to be used for activation. String aslname The hostname of the KEMP360 Central machine to be used for activation. String aslport The port to contact KEMP360 Central on. Int32 LicenseTypeId Specify the LicenseTypeId of the license to activate. To retrieve a list of license types and IDs, run the Get-AslLicenseType command. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String aslipaddr The IP address of the KEMP360 Central machine to be used for activation. String String aslname The hostname of the KEMP360 Central machine to be used for activation. String String aslport The port to contact KEMP360 Central on. Int32 Int32 LicenseTypeId Specify the LicenseTypeId of the license to activate. To retrieve a list of license types and IDs, run the Get-AslLicenseType command. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String aslipaddress The IP address of the KEMP360 Central machine to be used for activation. string string Either the aslipaddr or aslname parameter must be provided for this command to run successfully. -------------------------- Example -------------------------- PS C:\> Request-LicenseOnPremise -aslipaddr 172.16.128.69 -aslname lm-act-server-default -aslport 443 Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Data.........: @{AslServerIpAddress=172.16.128.69; AslServerPort=443; AslServerFqdn=lm-act-server-default} Reset-LogStatistics Reset the LoadMaster statistics. Reset LogStatistics Reset the LoadMaster statistics (total connections, Bytes per Second, and so on) that can be retreived with the Get-LogStatistics command. Reset-LogStatistics LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Reset-LogStatistics LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Reset-LogStatistics Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Restart-Lm Allows you to restart the LoadMaster. Restart Lm Allows you to restart the LoadMaster. Restart-Lm LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Shutdown Specifies to shut down the LoadMaster. Issuing this command will require physical access to power the LoadMaster back on. SwitchParameter Force Enable this command to force the command to execute without a confirmation. SwitchParameter SleepTime This parameter is not mandatory. The SleepTime parameter defines the amount of wait time. The default value is 12 seconds. The Cycles parameter value defines the amount of cycles of sleep time to wait for. The default value is 8 seconds. Therefore, by default the API waits for 96 seconds when the Restart-Lm command is run. Int32 Cycles This parameter is not mandatory. The Cycles parameter value defines the amount of cycles of sleep time that is waited for. The default is 8 seconds. The SleepTime parameter defines the amount of wait time. The default value is 12 seconds. Therefore, by default the API waits for 96 seconds when the Restart-Lm command is run. Int32 InformationAction ActionPreference InformationVariable String WhatIf Enable this command to see what the command will do without actually executing the command. SwitchParameter Confirm Confirms that the action should be carried out. SwitchParameter Restart-Lm LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String Shutdown Specifies to shut down the LoadMaster. Issuing this command will require physical access to power the LoadMaster back on. SwitchParameter Force Enable this command to force the command to execute without a confirmation. SwitchParameter SleepTime This parameter is not mandatory. The SleepTime parameter defines the amount of wait time. The default value is 12 seconds. The Cycles parameter value defines the amount of cycles of sleep time to wait for. The default value is 8 seconds. Therefore, by default the API waits for 96 seconds when the Restart-Lm command is run. Int32 Cycles This parameter is not mandatory. The Cycles parameter value defines the amount of cycles of sleep time that is waited for. The default is 8 seconds. The SleepTime parameter defines the amount of wait time. The default value is 12 seconds. Therefore, by default the API waits for 96 seconds when the Restart-Lm command is run. Int32 InformationAction ActionPreference InformationVariable String WhatIf Enable this command to see what the command will do without actually executing the command. SwitchParameter Confirm Confirms that the action should be carried out. SwitchParameter LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object Shutdown Specifies to shut down the LoadMaster. Issuing this command will require physical access to power the LoadMaster back on. SwitchParameter SwitchParameter Force Enable this command to force the command to execute without a confirmation. SwitchParameter SwitchParameter SleepTime This parameter is not mandatory. The SleepTime parameter defines the amount of wait time. The default value is 12 seconds. The Cycles parameter value defines the amount of cycles of sleep time to wait for. The default value is 8 seconds. Therefore, by default the API waits for 96 seconds when the Restart-Lm command is run. Int32 Int32 Cycles This parameter is not mandatory. The Cycles parameter value defines the amount of cycles of sleep time that is waited for. The default is 8 seconds. The SleepTime parameter defines the amount of wait time. The default value is 12 seconds. Therefore, by default the API waits for 96 seconds when the Restart-Lm command is run. Int32 Int32 InformationAction ActionPreference ActionPreference InformationVariable String String WhatIf Enable this command to see what the command will do without actually executing the command. SwitchParameter SwitchParameter Confirm Confirms that the action should be carried out. SwitchParameter SwitchParameter CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Restart-Lm -Confirm -Force Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Restart-LoadBalancer WARNING: This function is deprecated. Use the following command instead: Restart-Lm Restart LoadBalancer WARNING: This function is deprecated. Use the following command instead: Restart-Lm Restart-LoadBalancer LoadBalancer String LBPort Int32 Credential Object Shutdown SwitchParameter Force SwitchParameter SleepTime Int32 Cycles Int32 InformationAction ActionPreference InformationVariable String WhatIf SwitchParameter Confirm SwitchParameter Restart-LoadBalancer LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String Shutdown SwitchParameter Force SwitchParameter SleepTime Int32 Cycles Int32 InformationAction ActionPreference InformationVariable String WhatIf SwitchParameter Confirm SwitchParameter LoadBalancer String String LBPort Int32 Int32 Credential Object Object Shutdown SwitchParameter SwitchParameter Force SwitchParameter SwitchParameter SleepTime Int32 Int32 Cycles Int32 Int32 InformationAction ActionPreference ActionPreference InformationVariable String String WhatIf SwitchParameter SwitchParameter Confirm SwitchParameter SwitchParameter CertificateStoreLocation String String SubjectCN String String Restore-Certificate WARNING: This function is deprecated. Use the following command instead: Restore-TlsCertificate Restore Certificate WARNING: This function is deprecated. Use the following command instead: Restore-TlsCertificate Restore-Certificate Password String Path String Type String LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String Restore-Certificate Password String Path String Type String LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String Password String String Path String String Type String String LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String Restore-LmConfiguration Allows you to restore the LoadMaster using a backup file previously saved. Restore LmConfiguration Allows you to restore the LoadMaster using a backup file previously saved. Restore-LmConfiguration Path The local path to the backup file. String Type The type of information to restore. Valid values are: Base Base + VS Base + Geo VS VS + Geo Geo SSO/LDAP All String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Restore-LmConfiguration Path The local path to the backup file. String Type The type of information to restore. Valid values are: Base Base + VS Base + Geo VS VS + Geo Geo SSO/LDAP All String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String Path The local path to the backup file. String String Type The type of information to restore. Valid values are: Base Base + VS Base + Geo VS VS + Geo Geo SSO/LDAP All String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Restore-LmConfiguration -Path C:\backups\LMBackups_2013_11_04.17_43 -Type Base Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Restore-LoadBalancer WARNING: This function is deprecated. Use the following command instead: Restore-LmConfiguration Restore LoadBalancer WARNING: This function is deprecated. Use the following command instead: Restore-LmConfiguration Restore-LoadBalancer Path String Type String LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String Restore-LoadBalancer Path String Type String LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String Path String String Type String String LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String Restore-Patch WARNING: This function is deprecated. Use the following command instead: Uninstall-LmPatch Restore Patch WARNING: This function is deprecated. Use the following command instead: Uninstall-LmPatch Restore-Patch LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String Restore-Patch LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String Restore-TlsCertificate Allows you to restore an existing certificate to the LoadMaster. Restore TlsCertificate Allows you to restore an existing certificate to the LoadMaster. Restore-TlsCertificate Password The password that was used to backup the certificate, if needed. String Path The local path to the certificate backup file. String Type The type of certificate to restore from the backup file. This parameter is required. This parameter has three possible values: - Full - All Virtual Service and intermediate certificates - Third - Intermediate certificates only - Vs - Virtual Service certificates only String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Restore-TlsCertificate Password The password that was used to backup the certificate, if needed. String Path The local path to the certificate backup file. String Type The type of certificate to restore from the backup file. This parameter is required. This parameter has three possible values: - Full - All Virtual Service and intermediate certificates - Third - Intermediate certificates only - Vs - Virtual Service certificates only String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String Password The password that was used to backup the certificate, if needed. String String Path The local path to the certificate backup file. String String Type The type of certificate to restore from the backup file. This parameter is required. This parameter has three possible values: - Full - All Virtual Service and intermediate certificates - Third - Intermediate certificates only - Vs - Virtual Service certificates only String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Restore-TlsCertificate -Password password -Type Full -Path C:\Certificates\CertBackup Example Output: ok Set-AdaptiveCheck WARNING: This function is deprecated. Use the following command instead: Set-AdcAdaptiveHealthCheck Set AdaptiveCheck WARNING: This function is deprecated. Use the following command instead: Set-AdcAdaptiveHealthCheck Set-AdaptiveCheck AdaptiveURL String AdaptivePort Int32 AdaptiveInterval Int32 MinPercent Int16 LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String Set-AdaptiveCheck AdaptiveURL String AdaptivePort Int32 AdaptiveInterval Int32 MinPercent Int16 LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String AdaptiveURL String String AdaptivePort Int32 Int32 AdaptiveInterval Int32 Int32 MinPercent Int16 Int16 LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String Set-AdcAdaptiveHealthCheck Allows you to set the values of the Adaptive Health Checking options. Set AdcAdaptiveHealthCheck Allows you to set the values of the Adaptive Health Checking options. Set-AdcAdaptiveHealthCheck AdaptiveURL The URL on the Real Servers which will return the current load of the Real Server. String AdaptivePort The port on the Real Servers used to access the URL containing the current load of the Real Server. Int32 AdaptiveInterval When using adaptive scheduling, the Real Servers are polled to retrieve their loading values. How often this occurs can be specified here. Int32 MinPercent The minimum load of the Real Server, below which the Real Server is said to be idle. Int16 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Set-AdcAdaptiveHealthCheck AdaptiveURL The URL on the Real Servers which will return the current load of the Real Server. String AdaptivePort The port on the Real Servers used to access the URL containing the current load of the Real Server. Int32 AdaptiveInterval When using adaptive scheduling, the Real Servers are polled to retrieve their loading values. How often this occurs can be specified here. Int32 MinPercent The minimum load of the Real Server, below which the Real Server is said to be idle. Int16 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String AdaptiveURL The URL on the Real Servers which will return the current load of the Real Server. String String AdaptivePort The port on the Real Servers used to access the URL containing the current load of the Real Server. Int32 Int32 AdaptiveInterval When using adaptive scheduling, the Real Servers are polled to retrieve their loading values. How often this occurs can be specified here. Int32 Int32 MinPercent The minimum load of the Real Server, below which the Real Server is said to be idle. Int16 Int16 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Set-AdcAdaptiveHealthCheck -AdaptiveURL www.example.com Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. AdaptiveURL : www.example.com AdaptivePort : 80 AdaptiveInterval : 7 MinPercent : 5 Set-AdcContentRule Allows you to set a rule in the LoadMaster. Set AdcContentRule Allows you to set a rule in the LoadMaster. Including the Confirm parameter opens a confirmation dialog. Set-AdcContentRule RuleName The name of the rule. String MatchType Specifies whether the rule matches on a regular expression (regex), prefix, or postfix. This parameter defaults to regex, but will also accept prefix or postfix. String IncHost Specifies whether to include the host in the URL. Boolean NoCase Specifies whether to ignore case/capitalization. Boolean Negate Specifies whether to invert the case of the match. Boolean IncQuery Append the query string to the URI before performing a match. Boolean Header Specifies the header that a match should be performed on. Set this to body to match on the body of a request. String Pattern Specifies the pattern to search for. String Replacement Specifies the replacement string for the pattern. String Type The type of content rule: 0 - Content Matching 1 - Add Header 2 - Delete Header 3 - Replace Header 4 - Modify URL 5 - Replace String in Response Body The other parameters available for the Set-AdcContentRule command depend on the "type" of content rule being added. Int32 MustFail If this rule is matched, then always fail to connect. 0 - Disabled (do not fail to connect) 1 - Enabled (fail to connect) Int32 OnlyOnFlag Only try to execute this rule if the specified flag is set by another rule (the OnlyOnFlag parameter is used in conjunction with the SetFlagOnMatch parameter). Using the OnlyOnFlag and SetFlagOnMatch parameters, it is possible to make rules dependent on each other, that is, only execute a particular rule if another rule has been successfully matched ('chaining' rules). For more detailed instructions on ‘chaining’ rules, please refer to the Content Rules, Feature Description document on the KEMP Documentation Page: https://kemptechnologies.com/loadmaster-documentation/ Valid values: 0-9 Int32 SetFlagOnMatch SetFlagOnMatch: If the rule is successfully matched, set the specified flag. Using the OnlyOnFlag and SetFlagOnMatch parameters, it is possible to make rules dependent on each other, that is, only execute a particular rule if another rule has been successfully matched. For more detailed instructions on ‘chaining’ rules, please refer to the Content Rules, Feature Description document on the KEMP Documentation Page: https://kemptechnologies.com/loadmaster-documentation/. Valid values: 0-9 Int32 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Set-AdcContentRule RuleName The name of the rule. String MatchType Specifies whether the rule matches on a regular expression (regex), prefix, or postfix. This parameter defaults to regex, but will also accept prefix or postfix. String IncHost Specifies whether to include the host in the URL. Boolean NoCase Specifies whether to ignore case/capitalization. Boolean Negate Specifies whether to invert the case of the match. Boolean IncQuery Append the query string to the URI before performing a match. Boolean Header Specifies the header that a match should be performed on. Set this to body to match on the body of a request. String Pattern Specifies the pattern to search for. String Replacement Specifies the replacement string for the pattern. String Type The type of content rule: 0 - Content Matching 1 - Add Header 2 - Delete Header 3 - Replace Header 4 - Modify URL 5 - Replace String in Response Body The other parameters available for the Set-AdcContentRule command depend on the "type" of content rule being added. Int32 MustFail If this rule is matched, then always fail to connect. 0 - Disabled (do not fail to connect) 1 - Enabled (fail to connect) Int32 OnlyOnFlag Only try to execute this rule if the specified flag is set by another rule (the OnlyOnFlag parameter is used in conjunction with the SetFlagOnMatch parameter). Using the OnlyOnFlag and SetFlagOnMatch parameters, it is possible to make rules dependent on each other, that is, only execute a particular rule if another rule has been successfully matched ('chaining' rules). For more detailed instructions on ‘chaining’ rules, please refer to the Content Rules, Feature Description document on the KEMP Documentation Page: https://kemptechnologies.com/loadmaster-documentation/ Valid values: 0-9 Int32 SetFlagOnMatch SetFlagOnMatch: If the rule is successfully matched, set the specified flag. Using the OnlyOnFlag and SetFlagOnMatch parameters, it is possible to make rules dependent on each other, that is, only execute a particular rule if another rule has been successfully matched. For more detailed instructions on ‘chaining’ rules, please refer to the Content Rules, Feature Description document on the KEMP Documentation Page: https://kemptechnologies.com/loadmaster-documentation/. Valid values: 0-9 Int32 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String RuleName The name of the rule. String String MatchType Specifies whether the rule matches on a regular expression (regex), prefix, or postfix. This parameter defaults to regex, but will also accept prefix or postfix. String String IncHost Specifies whether to include the host in the URL. Boolean Boolean NoCase Specifies whether to ignore case/capitalization. Boolean Boolean Negate Specifies whether to invert the case of the match. Boolean Boolean IncQuery Append the query string to the URI before performing a match. Boolean Boolean Header Specifies the header that a match should be performed on. Set this to body to match on the body of a request. String String Pattern Specifies the pattern to search for. String String Replacement Specifies the replacement string for the pattern. String String Type The type of content rule: 0 - Content Matching 1 - Add Header 2 - Delete Header 3 - Replace Header 4 - Modify URL 5 - Replace String in Response Body The other parameters available for the Set-AdcContentRule command depend on the "type" of content rule being added. Int32 Int32 MustFail If this rule is matched, then always fail to connect. 0 - Disabled (do not fail to connect) 1 - Enabled (fail to connect) Int32 Int32 OnlyOnFlag Only try to execute this rule if the specified flag is set by another rule (the OnlyOnFlag parameter is used in conjunction with the SetFlagOnMatch parameter). Using the OnlyOnFlag and SetFlagOnMatch parameters, it is possible to make rules dependent on each other, that is, only execute a particular rule if another rule has been successfully matched ('chaining' rules). For more detailed instructions on ‘chaining’ rules, please refer to the Content Rules, Feature Description document on the KEMP Documentation Page: https://kemptechnologies.com/loadmaster-documentation/ Valid values: 0-9 Int32 Int32 SetFlagOnMatch SetFlagOnMatch: If the rule is successfully matched, set the specified flag. Using the OnlyOnFlag and SetFlagOnMatch parameters, it is possible to make rules dependent on each other, that is, only execute a particular rule if another rule has been successfully matched. For more detailed instructions on ‘chaining’ rules, please refer to the Content Rules, Feature Description document on the KEMP Documentation Page: https://kemptechnologies.com/loadmaster-documentation/. Valid values: 0-9 Int32 Int32 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String IncQueryfalse Append the query string to the URI before performing a match. boolean boolean -------------------------- Example -------------------------- PS C:\> Set-AdcContentRule -Name TestRule1 -Negate $True -NoCase $False -Pattern /^example$/ Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Set-AdcL7Configuration Allows you to set the values of Layer 7 Configuration options. Set AdcL7Configuration Allows you to set the values of Layer 7 Configuration options. Set-AdcL7Configuration ScalingOver64KConnections Under very high load situations, Port Exhaustion can occur. Enabling this option will allow the setting of Alternate Source Addresses which can be used to expand the number of local ports available. If more than 64K concurrent connections are required, enable the Allow Connection Scaling over 64K Connections option and set the Virtual Service IP as the alternate address in the Alternate Source Addresses input field. This allows each Virtual Service to have its own pool of source ports. Transparent Virtual Services are capped at 64K concurrent connections. This limit is on a per Virtual Service basis. If, after selecting this option, you set some Alternate Source Addresses, you will not be able to disable the Allow connection scaling over 64K Connections option. Boolean AlwaysCheckPersist By default, the L7 module only checks persist on the first request of a HTTP/1.1 connection. Enabling this option will check the persist on every request. When Accept Changes is selected, all persistence changes are saved, even in the middle of a connection. Valid values are: No Yes Yes - Accept Changes String AddPortToActiveCookie When using the LoadMaster behind a NATing gateway, all client addresses are the same. To create individual cookies the remote port can also be added to the cookie. Enabling this option when not needed wastes resources. Valid values are: 0 - Disable 1 - Enable Boolean RFCConform By default, the LoadMaster conforms to the RFC when parsing HTTP headers. Disabling this will allow interworking with some broken browsers. Valid values: 0 - Disable 1 - Enable Boolean CloseOnError When enabled, the LoadMaster will always close the client connection when it sends back an error response. For Example, this changes the behaviour of the LoadMaster when sending back a 304 File not changed message after receiving an If-Modified-Since HTTP header. Boolean AddViaHeaderInCacheResponses When enabled, a VIA header field will be added to all cache responses. The Virtual Service address will be the address used. Valid values are: 0 - Disable 1 - Enable Boolean RSAreLocal When checking to see if a client is on the local subnet, also check to see if the client is actually a Real Server. Boolean DropOnRSFail By default, existing connections are not closed if a Real Server fails. Enabling this feature causes all connections to be immediately dropped on Real Server failure. Valid values: 0 - Disable 1 - Enable Boolean DropAtDrainEnd If enabled, all open connections to disabled Real Servers will be dropped at the end of the Real Servers Drain Stop Time or immediately if there are no Persist entries associated with the Real Server. Boolean Transparent Globally enable or disable the transparent handling of connections using the L7 subsystem. L4 connections are ALWAYS handled transparently. Boolean L7AuthTimeoutSecs The duration (in seconds) that a connection remains open for while authentication is ongoing. This value can be between 30 and 300. Int16 L7ClientTokenTimeoutSecs The duration (in seconds) to wait for the client token while the process of authentication is ongoing (used for RSA SecurID and RADIUS authentication). The default value for this parameter is 120. The range for this parameter is 60-300. Int16 L7ConnectionDrainTimeoutSecs If enabled, all open connections to disabled Real Servers will be dropped at the end of the Real Servers Drain Stop Time OR immediately if there are no Persist entries associated with the Real Server. Valid values are: 0 - Disable 1 - Enable Int32 AdditionalL7Header This enables Layer 7 header injection for HTTP/HTTPS Virtual Services. Header injection can be set to X-ClientSide (KEMP LoadMaster specific), X-Forwarded-For, or None. String OneHundredContinueHandling Determines how 100-Continue Handling messages are handled. The available options are: RFC-2616 Compliant: conforms with the behavior as outlined in RFC-2616 Require 100-Continue: forces the LoadMaster to wait for the 100-Continue message RFC-7231 Compliant: ensures the LoadMaster does not wait for 100-Continue messages Modifying how 100 Continue messages are handled by the system requires an understanding of the relevant technologies as described in the RFCs listed above. It is recommended that you speak with a KEMP Technical Support engineer before making changes to these settings. String AllowEmptyPosts By default the LoadMaster blocks POSTs that do not contain a Content-Length or Transfer-Encoding header to indicate the length of the requests payload. When this parameter is set to true, such requests are assumed to have no payload data and are therefore not rejected. Boolean AllowEmptyHttpHeaders By default, if the LoadMaster is processing HTTP headers it ignores HTTP headers that have empty content. This can break some SOAP services, even though it is against the HTTP RFCs. Setting this option allows these empty headers through. Valid values are: 0 - Disable 1 - Enable Boolean ForceCompleteRSMatch By default, when the LoadMaster is trying to locate a Real Server for use with content switching, it tries to use the same Real Server as currently selected, even if the port is not the same. Enabling this parameter forces the port to also be compared. Valid values are: 0 - Disable 1 - Enable Boolean SlowStart When using the Least Connection (or Weighted Least Connection) scheduling method, specify the time (in seconds) over which the load to a Real Server which has just come online will be throttled. Int16 ShareSubVSPersistance By default, each SubVS has an independent persistence table. Enabling this parameter will allow the SubVS to share this information. Valid values are: 0 - Disable 1 - Enable Boolean LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Set-AdcL7Configuration ScalingOver64KConnections Under very high load situations, Port Exhaustion can occur. Enabling this option will allow the setting of Alternate Source Addresses which can be used to expand the number of local ports available. If more than 64K concurrent connections are required, enable the Allow Connection Scaling over 64K Connections option and set the Virtual Service IP as the alternate address in the Alternate Source Addresses input field. This allows each Virtual Service to have its own pool of source ports. Transparent Virtual Services are capped at 64K concurrent connections. This limit is on a per Virtual Service basis. If, after selecting this option, you set some Alternate Source Addresses, you will not be able to disable the Allow connection scaling over 64K Connections option. Boolean AlwaysCheckPersist By default, the L7 module only checks persist on the first request of a HTTP/1.1 connection. Enabling this option will check the persist on every request. When Accept Changes is selected, all persistence changes are saved, even in the middle of a connection. Valid values are: No Yes Yes - Accept Changes String AddPortToActiveCookie When using the LoadMaster behind a NATing gateway, all client addresses are the same. To create individual cookies the remote port can also be added to the cookie. Enabling this option when not needed wastes resources. Valid values are: 0 - Disable 1 - Enable Boolean RFCConform By default, the LoadMaster conforms to the RFC when parsing HTTP headers. Disabling this will allow interworking with some broken browsers. Valid values: 0 - Disable 1 - Enable Boolean CloseOnError When enabled, the LoadMaster will always close the client connection when it sends back an error response. For Example, this changes the behaviour of the LoadMaster when sending back a 304 File not changed message after receiving an If-Modified-Since HTTP header. Boolean AddViaHeaderInCacheResponses When enabled, a VIA header field will be added to all cache responses. The Virtual Service address will be the address used. Valid values are: 0 - Disable 1 - Enable Boolean RSAreLocal When checking to see if a client is on the local subnet, also check to see if the client is actually a Real Server. Boolean DropOnRSFail By default, existing connections are not closed if a Real Server fails. Enabling this feature causes all connections to be immediately dropped on Real Server failure. Valid values: 0 - Disable 1 - Enable Boolean DropAtDrainEnd If enabled, all open connections to disabled Real Servers will be dropped at the end of the Real Servers Drain Stop Time or immediately if there are no Persist entries associated with the Real Server. Boolean Transparent Globally enable or disable the transparent handling of connections using the L7 subsystem. L4 connections are ALWAYS handled transparently. Boolean L7AuthTimeoutSecs The duration (in seconds) that a connection remains open for while authentication is ongoing. This value can be between 30 and 300. Int16 L7ClientTokenTimeoutSecs The duration (in seconds) to wait for the client token while the process of authentication is ongoing (used for RSA SecurID and RADIUS authentication). The default value for this parameter is 120. The range for this parameter is 60-300. Int16 L7ConnectionDrainTimeoutSecs If enabled, all open connections to disabled Real Servers will be dropped at the end of the Real Servers Drain Stop Time OR immediately if there are no Persist entries associated with the Real Server. Valid values are: 0 - Disable 1 - Enable Int32 AdditionalL7Header This enables Layer 7 header injection for HTTP/HTTPS Virtual Services. Header injection can be set to X-ClientSide (KEMP LoadMaster specific), X-Forwarded-For, or None. String OneHundredContinueHandling Determines how 100-Continue Handling messages are handled. The available options are: RFC-2616 Compliant: conforms with the behavior as outlined in RFC-2616 Require 100-Continue: forces the LoadMaster to wait for the 100-Continue message RFC-7231 Compliant: ensures the LoadMaster does not wait for 100-Continue messages Modifying how 100 Continue messages are handled by the system requires an understanding of the relevant technologies as described in the RFCs listed above. It is recommended that you speak with a KEMP Technical Support engineer before making changes to these settings. String AllowEmptyPosts By default the LoadMaster blocks POSTs that do not contain a Content-Length or Transfer-Encoding header to indicate the length of the requests payload. When this parameter is set to true, such requests are assumed to have no payload data and are therefore not rejected. Boolean AllowEmptyHttpHeaders By default, if the LoadMaster is processing HTTP headers it ignores HTTP headers that have empty content. This can break some SOAP services, even though it is against the HTTP RFCs. Setting this option allows these empty headers through. Valid values are: 0 - Disable 1 - Enable Boolean ForceCompleteRSMatch By default, when the LoadMaster is trying to locate a Real Server for use with content switching, it tries to use the same Real Server as currently selected, even if the port is not the same. Enabling this parameter forces the port to also be compared. Valid values are: 0 - Disable 1 - Enable Boolean SlowStart When using the Least Connection (or Weighted Least Connection) scheduling method, specify the time (in seconds) over which the load to a Real Server which has just come online will be throttled. Int16 ShareSubVSPersistance By default, each SubVS has an independent persistence table. Enabling this parameter will allow the SubVS to share this information. Valid values are: 0 - Disable 1 - Enable Boolean LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String ScalingOver64KConnections Under very high load situations, Port Exhaustion can occur. Enabling this option will allow the setting of Alternate Source Addresses which can be used to expand the number of local ports available. If more than 64K concurrent connections are required, enable the Allow Connection Scaling over 64K Connections option and set the Virtual Service IP as the alternate address in the Alternate Source Addresses input field. This allows each Virtual Service to have its own pool of source ports. Transparent Virtual Services are capped at 64K concurrent connections. This limit is on a per Virtual Service basis. If, after selecting this option, you set some Alternate Source Addresses, you will not be able to disable the Allow connection scaling over 64K Connections option. Boolean Boolean AlwaysCheckPersist By default, the L7 module only checks persist on the first request of a HTTP/1.1 connection. Enabling this option will check the persist on every request. When Accept Changes is selected, all persistence changes are saved, even in the middle of a connection. Valid values are: No Yes Yes - Accept Changes String String AddPortToActiveCookie When using the LoadMaster behind a NATing gateway, all client addresses are the same. To create individual cookies the remote port can also be added to the cookie. Enabling this option when not needed wastes resources. Valid values are: 0 - Disable 1 - Enable Boolean Boolean RFCConform By default, the LoadMaster conforms to the RFC when parsing HTTP headers. Disabling this will allow interworking with some broken browsers. Valid values: 0 - Disable 1 - Enable Boolean Boolean CloseOnError When enabled, the LoadMaster will always close the client connection when it sends back an error response. For Example, this changes the behaviour of the LoadMaster when sending back a 304 File not changed message after receiving an If-Modified-Since HTTP header. Boolean Boolean AddViaHeaderInCacheResponses When enabled, a VIA header field will be added to all cache responses. The Virtual Service address will be the address used. Valid values are: 0 - Disable 1 - Enable Boolean Boolean RSAreLocal When checking to see if a client is on the local subnet, also check to see if the client is actually a Real Server. Boolean Boolean DropOnRSFail By default, existing connections are not closed if a Real Server fails. Enabling this feature causes all connections to be immediately dropped on Real Server failure. Valid values: 0 - Disable 1 - Enable Boolean Boolean DropAtDrainEnd If enabled, all open connections to disabled Real Servers will be dropped at the end of the Real Servers Drain Stop Time or immediately if there are no Persist entries associated with the Real Server. Boolean Boolean Transparent Globally enable or disable the transparent handling of connections using the L7 subsystem. L4 connections are ALWAYS handled transparently. Boolean Boolean L7AuthTimeoutSecs The duration (in seconds) that a connection remains open for while authentication is ongoing. This value can be between 30 and 300. Int16 Int16 L7ClientTokenTimeoutSecs The duration (in seconds) to wait for the client token while the process of authentication is ongoing (used for RSA SecurID and RADIUS authentication). The default value for this parameter is 120. The range for this parameter is 60-300. Int16 Int16 L7ConnectionDrainTimeoutSecs If enabled, all open connections to disabled Real Servers will be dropped at the end of the Real Servers Drain Stop Time OR immediately if there are no Persist entries associated with the Real Server. Valid values are: 0 - Disable 1 - Enable Int32 Int32 AdditionalL7Header This enables Layer 7 header injection for HTTP/HTTPS Virtual Services. Header injection can be set to X-ClientSide (KEMP LoadMaster specific), X-Forwarded-For, or None. String String OneHundredContinueHandling Determines how 100-Continue Handling messages are handled. The available options are: RFC-2616 Compliant: conforms with the behavior as outlined in RFC-2616 Require 100-Continue: forces the LoadMaster to wait for the 100-Continue message RFC-7231 Compliant: ensures the LoadMaster does not wait for 100-Continue messages Modifying how 100 Continue messages are handled by the system requires an understanding of the relevant technologies as described in the RFCs listed above. It is recommended that you speak with a KEMP Technical Support engineer before making changes to these settings. String String AllowEmptyPosts By default the LoadMaster blocks POSTs that do not contain a Content-Length or Transfer-Encoding header to indicate the length of the requests payload. When this parameter is set to true, such requests are assumed to have no payload data and are therefore not rejected. Boolean Boolean AllowEmptyHttpHeaders By default, if the LoadMaster is processing HTTP headers it ignores HTTP headers that have empty content. This can break some SOAP services, even though it is against the HTTP RFCs. Setting this option allows these empty headers through. Valid values are: 0 - Disable 1 - Enable Boolean Boolean ForceCompleteRSMatch By default, when the LoadMaster is trying to locate a Real Server for use with content switching, it tries to use the same Real Server as currently selected, even if the port is not the same. Enabling this parameter forces the port to also be compared. Valid values are: 0 - Disable 1 - Enable Boolean Boolean SlowStart When using the Least Connection (or Weighted Least Connection) scheduling method, specify the time (in seconds) over which the load to a Real Server which has just come online will be throttled. Int16 Int16 ShareSubVSPersistance By default, each SubVS has an independent persistence table. Enabling this parameter will allow the SubVS to share this information. Valid values are: 0 - Disable 1 - Enable Boolean Boolean LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String AddCookiePort When using the LoadMaster behind a NATing gateway, all client addresses are the same. To create individual cookies the remote port can also be added to the cookie. Enabling this option when not needed wastes resources. boolean boolean AddVia Specify which headers to be added to HTTP requests. X-ClientSide and X-Forwarded-For are only added to non-transparent connections. 0 - Legacy Operation(X-Forwarded-For) 1 - X-Forwarded-For (+ Via) 2 - None 3 - X-ClientSide (+ Via) 4 - X-ClientSide (No Via) 5 - X-Forwarded-For (No Via) 6 - Via Only boolean boolean AlwaysPersist This parameter also accepts no and yes as valid values. No and Yes correspond to 0 and 1 respectively. boolean boolean AuthTimeout The duration (in seconds) that a connection remains open for while authentication is ongoing. This value can be between 30 and 300. int16 int16 ClientTokenTimeout The duration (in seconds) to wait for the client token while the process of authentication is ongoing (used for RSA SecurID and RADIUS authentication). The default value for this parameter is 120. int16 int16 DropOnFail By default, existing connections are not closed if a Real Server fails. Enabling this feature causes all connections to be immediately dropped on Real Server failure. boolean boolean Expect100 By default, the L7 module only waits for 100-Continue replies if it sees an Expect-100 header, use RFC-2616 Compliant. If the system will always wait for 100 Continue messages, use Require 100-Continue. If the client will always send the POST data even if a 100 Continue message is not sent, use RFC-7231 Compliant instead. int16 int16 RFConform By default, the LoadMaster conforms to the RFC when parsing HTTP headers. Disabling this will allow interworking with some broken browsers. boolean boolean LocalBind In very high load situations, local port exhaustion can occur. Enabling this option allows the setting of alternate source addresses. This can be used to expand the number of available local ports. boolean boolean AddForwardHeader This option, only available when L7 Transparency is disabled, allows the addition of either X-ClientSide or X-Forwarded For to the HTTP header. int16 int16 -------------------------- Example -------------------------- PS C:\> Set-AdcL7Configuration -OneHundredContinueHandling "RFC-2616 Compliant" Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed; Data=} Return Code..: 200 Response.....: Command successfully executed Data field...: @{AdcL7Configuration=} Param........: @{ScalingOver64KConnections=no; AlwaysCheckPersist=Yes - Accept Changes; AddPortToActiveCookie=no; RFCConform=yes; CloseOnError=no; AddVi aHeaderInCacheResponses=no; RSAreLocal=no; DropOnRSFail=no; DropAtDrainEnd=no; L7AuthTimeoutSecs=30; L7ClientTokenTimeoutSecs=120; L7ConnectionDrainTime outSecs=300; AdditionalL7Header=X-ClientSide; OneHundredContinueHandling=RFC-2616 Compliant; AllowEmptyPosts=no; AllowEmptyHttpHeaders=no; ForceComplete RSMatch=no; SlowStart=0; ShareSubVSPersistance=no} ScalingOver64KConnections : no AlwaysCheckPersist : Yes - Accept Changes AddPortToActiveCookie : no RFCConform : yes CloseOnError : no AddViaHeaderInCacheResponses : no RSAreLocal : no DropOnRSFail : no DropAtDrainEnd : no L7AuthTimeoutSecs : 30 L7ClientTokenTimeoutSecs : 120 L7ConnectionDrainTimeoutSecs : 300 AdditionalL7Header : X-ClientSide OneHundredContinueHandling : RFC-2616 Compliant AllowEmptyPosts : no AllowEmptyHttpHeaders : no ForceCompleteRSMatch : no SlowStart : 0 ShareSubVSPersistance : no Set-AdcL7LogInsightSplitConfiguration Allows you to set the value of the log split interval. Set AdcL7LogInsightSplitConfiguration Allows you to set the value of the log split interval. Set-AdcL7LogInsightSplitConfiguration logsplitinterval When using Log Insight Scheduling this is the number of messages that are received on a connection before the stream is rescheduled. The default value is 10. The range is 1-100. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Set-AdcL7LogInsightSplitConfiguration logsplitinterval When using Log Insight Scheduling this is the number of messages that are received on a connection before the stream is rescheduled. The default value is 10. The range is 1-100. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String logsplitinterval When using Log Insight Scheduling this is the number of messages that are received on a connection before the stream is rescheduled. The default value is 10. The range is 1-100. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String logsplit This value controls how many syslog messages should be sent to each server in the pool before moving to the next server. string string This command is only relevant for LoadMasters with the Log Insight Add-On Pack installed. -------------------------- Example -------------------------- PS C:\> Set-AdcL7LogInsightSplitConfiguration -logsplit 20 Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed; Data=} Return Code..: 200 Response.....: Command successfully executed Data field...: @{logsplitinterval=20} Set-AdcRealServer Configure options on a configured Real Server. Set AdcRealServer Modifies the settings for a Real Server that is already configured. Set-AdcRealServer VirtualService The IP address of the Virtual Service. String VSPort The port of the relevant Virtual Service. Int32 VSProtocol The protocol of the relevant Virtual Service. String VSIndex The index number of the Virtual Service or SubVS. To retrieve the VSIndex, run the Get-VirtualService command. Int32 RealServer The IP address that the Real Server being defined listens on. String RealServerPort The port that the Real Server will be listening on. Int32 RSIndex The index number of the Real Server to be modified. To retrieve the Real Server index, run the Get-VirtualService command. If modifying the Real Server-specific parameters of a SubVS, such as critical, weight and limit, specify the RS index of the SubVS along with the Virtual Service parameters of the parent Virtual Service. Int32 NewPort Used to change the Real Server port to a new value. Int32 Weight The Real Server's weight. This is weight of the Real Server, as used by the Weighted Round Robin, Weighted Least Connection and Adaptive scheduling methods. The default initial value for the weight is 1000, the maximum is 65535 and the minimum is 1. Int32 Forward Either NAT (Network Address Translation) or Route (Direct) forwarding. The available options are dependent on the other modes configured for the service. String Enable Specifies if the Real Server is enabled or disabled. Pass in a value of TRUE ($true) for enabled, and FALSE ($false) for disabled. Boolean Limit The maximum number of open connections that a Real Server will accept before it is taken out of the rotation. This is only available for Layer 7 traffic. Int64 Critical True or false to indicate whether this Real Server is required for the Virtual Service to be available. Boolean Follow Specify what Real Server the health check is based on by setting this parameter to the RsIndex of the Real Server to be followed. This can either be set to the RsIndex of the same Real Server in order to health check based on that particular Real Server status, or another Real Server can be specified. For example – if Real Server 1 is down, any Real Servers which have their health check based on Real Server 1 will also be marked as down, regardless of their actual Real Server status. Int32 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Set-AdcRealServer VirtualService The IP address of the Virtual Service. String VSPort The port of the relevant Virtual Service. Int32 VSProtocol The protocol of the relevant Virtual Service. String VSIndex The index number of the Virtual Service or SubVS. To retrieve the VSIndex, run the Get-VirtualService command. Int32 RealServer The IP address that the Real Server being defined listens on. String RealServerPort The port that the Real Server will be listening on. Int32 RSIndex The index number of the Real Server to be modified. To retrieve the Real Server index, run the Get-VirtualService command. If modifying the Real Server-specific parameters of a SubVS, such as critical, weight and limit, specify the RS index of the SubVS along with the Virtual Service parameters of the parent Virtual Service. Int32 NewPort Used to change the Real Server port to a new value. Int32 Weight The Real Server's weight. This is weight of the Real Server, as used by the Weighted Round Robin, Weighted Least Connection and Adaptive scheduling methods. The default initial value for the weight is 1000, the maximum is 65535 and the minimum is 1. Int32 Forward Either NAT (Network Address Translation) or Route (Direct) forwarding. The available options are dependent on the other modes configured for the service. String Enable Specifies if the Real Server is enabled or disabled. Pass in a value of TRUE ($true) for enabled, and FALSE ($false) for disabled. Boolean Limit The maximum number of open connections that a Real Server will accept before it is taken out of the rotation. This is only available for Layer 7 traffic. Int64 Critical True or false to indicate whether this Real Server is required for the Virtual Service to be available. Boolean Follow Specify what Real Server the health check is based on by setting this parameter to the RsIndex of the Real Server to be followed. This can either be set to the RsIndex of the same Real Server in order to health check based on that particular Real Server status, or another Real Server can be specified. For example – if Real Server 1 is down, any Real Servers which have their health check based on Real Server 1 will also be marked as down, regardless of their actual Real Server status. Int32 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String VirtualService The IP address of the Virtual Service. String String VSPort The port of the relevant Virtual Service. Int32 Int32 VSProtocol The protocol of the relevant Virtual Service. String String VSIndex The index number of the Virtual Service or SubVS. To retrieve the VSIndex, run the Get-VirtualService command. Int32 Int32 RealServer The IP address that the Real Server being defined listens on. String String RealServerPort The port that the Real Server will be listening on. Int32 Int32 RSIndex The index number of the Real Server to be modified. To retrieve the Real Server index, run the Get-VirtualService command. If modifying the Real Server-specific parameters of a SubVS, such as critical, weight and limit, specify the RS index of the SubVS along with the Virtual Service parameters of the parent Virtual Service. Int32 Int32 NewPort Used to change the Real Server port to a new value. Int32 Int32 Weight The Real Server's weight. This is weight of the Real Server, as used by the Weighted Round Robin, Weighted Least Connection and Adaptive scheduling methods. The default initial value for the weight is 1000, the maximum is 65535 and the minimum is 1. Int32 Int32 Forward Either NAT (Network Address Translation) or Route (Direct) forwarding. The available options are dependent on the other modes configured for the service. String String Enable Specifies if the Real Server is enabled or disabled. Pass in a value of TRUE ($true) for enabled, and FALSE ($false) for disabled. Boolean Boolean Limit The maximum number of open connections that a Real Server will accept before it is taken out of the rotation. This is only available for Layer 7 traffic. Int64 Int64 Critical True or false to indicate whether this Real Server is required for the Virtual Service to be available. Boolean Boolean Follow Specify what Real Server the health check is based on by setting this parameter to the RsIndex of the Real Server to be followed. This can either be set to the RsIndex of the same Real Server in order to health check based on that particular Real Server status, or another Real Server can be specified. For example – if Real Server 1 is down, any Real Servers which have their health check based on Real Server 1 will also be marked as down, regardless of their actual Real Server status. Int32 Int32 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String Port The port that the Virtual Service is listening on. int32 int32 Protocol Specify if the service is using TCP or UDP protocols. string string -------------------------- Example -------------------------- PS C:\> Set-AdcRealServer -Port 80 -Protocol tcp -RealServer 10.11.0.29 -RealServerPort 80 -VirtualService 10.11.0.199 -Enable $True -Forward route -Limit 100 -Weight 2000 Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Set-AdcServiceHealth Allows you to set the values of the Service Check options. Set AdcServiceHealth Allows you to set the values of the Service Check options. Set-AdcServiceHealth CheckInterval Defined in seconds, this is the delay between health checks. This includes clusters and FQDNs. Recommended and default value: 9 seconds Valid values range from the <mininterval> (9) to the <maxinterval> (901). The <mininterval> is RetryCount * ConnectTimeout + 1, that is, a value of 9 by default. The <maxinterval> is 901 [because that is what 60 (maximum Timeout) * 15 (maximum RetryCount) + 1 is]. You can manually set the CheckInterval to up to 120 seconds. The CheckInterval value may go above 120 if the ConnectTimeout and RetryCount parameters are configured with high enough values. If the CheckInterval is above 120 seconds, you must adjust the ConnectTimeout and RetryCount values to modify the CheckInterval. Int16 ConnectTimeout Defined in seconds, this is the allowed maximum wait time for a reply to a health check. Range: 4-60 Int16 RetryCount This is the consecutive number of times in which a health check must fail before it is marked down and removed from the load balancing pool. Range: 2-15 Int16 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Set-AdcServiceHealth CheckInterval Defined in seconds, this is the delay between health checks. This includes clusters and FQDNs. Recommended and default value: 9 seconds Valid values range from the <mininterval> (9) to the <maxinterval> (901). The <mininterval> is RetryCount * ConnectTimeout + 1, that is, a value of 9 by default. The <maxinterval> is 901 [because that is what 60 (maximum Timeout) * 15 (maximum RetryCount) + 1 is]. You can manually set the CheckInterval to up to 120 seconds. The CheckInterval value may go above 120 if the ConnectTimeout and RetryCount parameters are configured with high enough values. If the CheckInterval is above 120 seconds, you must adjust the ConnectTimeout and RetryCount values to modify the CheckInterval. Int16 ConnectTimeout Defined in seconds, this is the allowed maximum wait time for a reply to a health check. Range: 4-60 Int16 RetryCount This is the consecutive number of times in which a health check must fail before it is marked down and removed from the load balancing pool. Range: 2-15 Int16 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String CheckInterval Defined in seconds, this is the delay between health checks. This includes clusters and FQDNs. Recommended and default value: 9 seconds Valid values range from the <mininterval> (9) to the <maxinterval> (901). The <mininterval> is RetryCount * ConnectTimeout + 1, that is, a value of 9 by default. The <maxinterval> is 901 [because that is what 60 (maximum Timeout) * 15 (maximum RetryCount) + 1 is]. You can manually set the CheckInterval to up to 120 seconds. The CheckInterval value may go above 120 if the ConnectTimeout and RetryCount parameters are configured with high enough values. If the CheckInterval is above 120 seconds, you must adjust the ConnectTimeout and RetryCount values to modify the CheckInterval. Int16 Int16 ConnectTimeout Defined in seconds, this is the allowed maximum wait time for a reply to a health check. Range: 4-60 Int16 Int16 RetryCount This is the consecutive number of times in which a health check must fail before it is marked down and removed from the load balancing pool. Range: 2-15 Int16 Int16 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Set-AdcServiceHealth -RetryCount 3 -RetryInterval 10 Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Data field...: @{AdcServiceHealth=} CheckInterval : 121 ConnectionTimeout : 60 RetryCount : 2 Set-AdcSubVirtualService Configure a SubVS. Set AdcSubVirtualService This command enables you to set specific settings on a SubVS. Set-AdcSubVirtualService SubVSIndex The ID number of the SubVS to configure. Int32 AddVia Specifies which headers should be added to the HTTP stream. The parameter takes the following arguments: 0 = Legacy Operation 1 = X-Forwarded-For 2 = None 3 = X-Client-Side 4 = X-Client-Side No Via 5 = X-Forwarded-For No Via 6 = Via Only Int16 CheckType Specifies the protocol to use to check if the service is up. Valid options are "tcp", "icmp", "https", "http", "smtp", "nntp", "ftp", "telnet", "pop3", "imap", "rdp", "ldap" or "none". String CheckHost The address to use to check if the service is up. String CheckPattern A regular expression string that can be validate on a 200 reply to determine if the service is up. Specify an empty value to unset CheckPattern. String CheckUrl The URL to check if the service is up. The maximum character length for the CheckUrl parameter value is 126 characters. String CheckHeaders Specify up to four additional headers/fields which will be sent with each health check request. Separate the pairs with a pipe, for example; Host:xyc|UserAgent:prq. String LdapEndpoint Specify the LDAP endpoint to use for health checks (if LDAP is selected as the CheckType). If LDAP is selected as the health check protocol, the server IP address (or addresses) and ports from the LDAP endpoint configuration will be used instead of the Real Server IP address and port. String MatchLen This parameter is only relevant when the CheckType is set to "bdata". Specify the number of bytes to find the CheckPattern within. String CheckUse1_1 Specifies that the health checker use HTTP/1.1 instead of HTTP/1.0. Int32 CheckPort The port to use to check if the service is up. Specify 0 to unset CheckPort. Int32 EnhancedHealthChecks Enables or disables Enhanced Health Check Options for the Virtual Service. Boolean RsMinimum Specifies the minimum number of Real Servers that are required to be active for the Virtual Service to be considered up. Int32 Cookie Specifies a cookie name. This parameter is only relevant when the persistence mode is set to "cookie", "active-cookie", "cookie-src" or "active-cook-src". String Enable Enables or disables the Virtual Service. Boolean ErrorCode If no Real Servers are available, the LoadMaster can terminate the connection with an HTTP error code. Specify the error code number in this parameter. String ErrorUrl When no Real Servers are available and an error response is sent back to the client, a redirect URL can also be specified. String PortFollow This parameter was depreciated as of 7.1-24. For LoadMasters with version 7.1-24 or higher, use the FollowVSID parameter to set port following. Int32 ForceL7 Enabling ForceL7 means the Virtual Service runs at Layer 7 and not Layer 4. This may be needed for various reasons, including that only Layer 7 services can be non-transparent. Boolean Idletime Specifies the length of time (in seconds) that a connection may remain idle before it is closed. The range for this parameter is 0 to 86400. 0 means indefinitely. Int32 LocalBindAddresses Specifies a space-separated list of IP addresses. This corresponds to the Alternate Source Address in the Advanced Properties section of the WUI. Allow connections scaling over 64K Connections needs to be enabled in L7 Configuration for this feature to work. String[] VSType Specifies the type of service being load balanced: gen - Generic http - HTTP/HTTPS ts - Remote Terminal tls – STARTTLS protocols log – Log Insight String Nickname Specifies the "friendly" name of the service. In addition to the usual alphanumeric characters, the following "special" characters can be used as part of the Service Name: . @ - _ However, there must be at least one alphanumeric character before the special characters. String Persist Specifies the type of persistence (stickiness) to be used for this Virtual Service. The following persistence values are supported: ssl, cookie, active-cookie, cookie-src, active-cook-src, cookie-hash, cookie-hash-src, url, query-hash, host, header, super, super-src, src, rdp, rdp-src, rdp-sb, rdp-sb-src and none. Note: If setting the persistence mode to an option that requires a cookie (or query-hash), the cookie parameter must also be set. String PersistTimeout The length of time (in seconds) after the last connection that the LoadMaster will remember the persistence information. Timeout values are rounded down to an even number of minutes. Setting a value that is not a number of whole minutes results in the excess being ignored. Setting a value to less than 60 seconds results in a value of 0 being set, which disables persistency. Int32 QueryTag This is the query tag to be matched if the Persist type is set to query-hash. String Schedule Specifies the type of scheduling of new connections to Real Servers that is to be performed. The following values are supported: rr = round robin wrr = weighted round robin lc = least connection wlc = weighted least connection fixed = fixed weighting adaptive = resource based (adaptive) sh = source IP hash dl = weighted response time sdn-adaptive = resource based (SDN adaptive) String ServerInit Specifies one of the following values: 0 - Normal Protocols 1 - SMTP 2 - SSH 3 - Other Server Initiating 4 - IMAP4 5 - MySQL 6 - POP3 Int16 StandByAddr Specifies the IP address of the "Sorry" server that is to be used when no other Real Servers are available. This server will not be health checked and is assumed to be always available. String StandByPort Specifies the port of the "Sorry" server. String TransactionLimit This is a legacy parameter that should no longer be used. It was used previously when the SSL proxy was limited to 6K total connections. The transaction limit was used to limit one Virtual Service to only handle so many connections out of this 6K. On newer systems, where the limit is greater than 64K - this feature is no longer required. Int32 Transparent When using Layer 7, when this is enabled - the connection arriving at the Real Server appears to come directly from the client. Alternatively, the connection can be non-transparent which means that the connections at the Real Server appear to come from the LoadMaster. Boolean SubnetOriginating When transparency is not enabled, the source IP address of connections to the Real Servers is that of the Virtual Service. When transparency is enabled, the source IP address will be the IP address that is initiating connection to the Virtual Service. If the Real Server is on a subnet, and the Subnet Originating Requests option is enabled, then the subnet address of the LoadMaster will be used as the source IP address. Boolean QoS Specifies the Quality of Service. The following values are supported: 0 - Normal-Service 1 - Minimize-Cost 2 - Maximize-Reliability 4 - Maximize-Throughput 8 - Minimize-Delay String CheckUseGet When accessing the health check URL - the system can use the HEAD, the GET or the POST method: 0 - HEAD 1 - GET 2 - POST Int32 Verify Specifies a verification bitmask. The valid values of the Verify parameter are as follows: Bit 0: set this to 1 to enable detection intrusion. Note: Bit 0 needs to be set to 1 in order to use the other two bits. Bit 1: Determines whether to reject or drop a connection. Setting it to 1 will drop the connection. Bit 2: Determines whether to give just warnings on bad requests or also on malicious (but not invalid) requests. The following table lists the valid integers and the values they set the fields to when used: Integer Detect Malicious Requests Intrusion Handling Warnings Checkbox 0 Disabled N/A N/A 1 Enabled Drop Connection Unchecked 2 Enabled Send Reject Unchecked 3 Enabled Send Reject Unchecked 4 Enabled Drop Connection Checked 5 Enabled Drop Connection Checked 6 Enabled Send Reject Checked 7 Enabled Send Reject Checked Int16 ExtraHdrKey Specifies the key for the extra header to be inserted into every request sent to the Real Servers. String ExtraHdrValue Specifies the value for the extra header to be inserted into every request sent to the Real Servers. String AllowedHosts This parameter is only relevant when ESP is enabled. Specifies all the virtual hosts that can be accessed via this Virtual Service. String AllowedDirectories This parameter is only relevant when ESP is enabled. Specifies all the virtual directories that can be accessed via this Virtual Service. String AllowedGroups Specifies the groups that are allowed to access this Virtual Service. String GroupSIDs Specify the group SID(s) that are allowed to access this Virtual Service. Multiple SIDs can be separating them with a semicolon. String SteeringGroups Enter the Active Directory group names that will be used for steering traffic. Use a semi-colon to separate multiple group names. The steering group index number corresponds to the location of the group in this list. String IncludeNestedGroups Specify if nested groups should be included in the authentication attempt. Boolean DisplayPubPriv Display the public/private option on the login page. Based on the option the user selects on the login form, the session timeout value will be set to the value specified for either the public or private timeout. Boolean DisablePasswordForm Enabling this option removes the password field from the login page. This may be needed when password validation is not required, for example if using RSA SecurID authentication in a singular fashion. Boolean Domain Specifies the Single Sign On (SSO) domain in which this Virtual Service will operate. String AltDomains Specifies alternative domains to be assigned to a Virtual Service when configuring multi-domain authentication. To specify multiple alternative domains use a space-separated list. String Logoff This parameter is only relevant when ESP is enabled and when the Client Authentication Mode is set to Form Based. Specify the string that the LoadMaster should use to detect a logout event. Multiple logoff strings can be specified by using a space-separated list. If the URL to be matched contains sub-directories before the specified string, the Logoff String will not be matched. Therefore the LoadMaster will not log the user off. String ESPLogs Enable ESP logging. Valid values are below: 0 - Logging off 1 - User Access 2 - Security 3 - User Access and Security 4 - Connection 5 - User Access and Connection 6 - Security and connection 7 - User Access, Security and Connection Note: The only valid values for SMTP services are 0 and 4. For SMTP services, security issues are always logged. Nothing is logged for user access because there are no logins. Int16 SMTPAllowedDomains Specifies all the permitted domains that are allowed to be received by this Virtual Service. String ESPEnabled Specifies whether to enable or disable the Edge Security Pack (ESP) features. Boolean UserPwdChangeUrl This is relevant when using form-based or LDAP authentication. Specify the URL that users can use to change their password. If a user’s password has expired, or if they must reset their password, this URL and the UserPwdChangeMsg is displayed on the login form. This URL must be put into the exception list for authentication, if required. String UserPwdChangeMsg This parameter is only relevant if the UserPwdChangeURL parameter is set. Specify the text to be displayed on the login form when the user must reset their password. String SecurityHeaderOptions Int16 InputAuthMode Specifies the client authentication method to be used: 0 - Delegate to Server 1 - Basic Authentication 2 - Form Based 3 - KCD 4 - Client Certificate 5 - NTLM Int16 OutConf String OutputAuthMode Specifies the server authentication mode to be used: 0 - None 1 - Basic Authentication 2 - KCD Int16 StartTLSMode 0 - HTTP/HTTPS (the Service Type needs to be set to HTTP/HTTPS for this to work) The Virtual Service Type must be set to STARTTLS for the remaining values to be set: 1 - SMTP (STARTTLS if requested) 2 - SMTP (STARTTLS always) 3 - FTP 4 - IMAP 6 - POP3 Int16 MultiConnect Enabling this option permits the LoadMaster to manage connection handling between the LoadMaster and the Real Servers. Requests from multiple clients will be sent over the same TCP connection. Multiplexing only works for simple HTTP GET operations. This parameter cannot be enabled in certain situations, for example if WAF, ESP or SSL Acceleration is enabled. Boolean SingleSignOnDir This parameter relates to the SSO Image Set drop-down in the ESP Options section of the modify Virtual Service screen. Specify the name of the image set to be used for the login screen. If no image set is specified, the default Exchange image set will be used. String OCSPVerify Specifies whether to verify (via Online Certificate Status Protocol (OCSP)) that the client certificate is valid. String FollowVSID Specifies the ID of the Virtual Service to follow. Int32 TlsType Specify which of the following protocols to support; SSLv3, TLS1.0, TLS1.1 or TLS1.2. By default, TLS1.1 and TLS1.2 are enabled. The protocols can be enabled and disabled using a bitmask value. Refer to the table below to find out what number corresponds to which settings. Number.... SSLv3.... TLS1.0.... TLS1.1.... TLS1.2 0......... Enabled.. Enabled... Enabled... Enabled 1......... Disabled. Enabled... Enabled... Enabled 2......... Enabled.. Disabled.. Enabled... Enabled 3......... Disabled. Disabled.. Enabled... Enabled 4......... Enabled.. Enabled... Disabled.. Enabled 5......... Disabled. Enabled... Disabled.. Enabled 6......... Enabled.. Disabled.. Disabled.. Enabled 7......... Disabled. Disabled.. Disabled.. Enabled 8......... Enabled.. Enabled... Enabled... Disabled 9......... Disabled. Enabled... Enabled... Disabled 10........ Enabled.. Disabled.. Enabled... Disabled 11........ Disabled. Disabled.. Enabled... Disabled 12........ Enabled.. Enabled... Disabled.. Disabled 13........ Disabled. Enabled... Disabled.. Disabled 14........ Enabled.. Disabled.. Disabled.. Disabled Int32 CheckPostData This parameter is only relevant if the HTTP Method is set to POST. When using the POST method, up to 2047 characters of POST data can be sent to the server. String CheckCodes A space-separated list of HTTP status codes that should be treated as successful when received from the Real Server. Range: 300-599 String PreProcPrecedence This parameter should be used in conjunction with PreProcPrecedencePos. This parameter is used to specify the name of the existing rule whose position you wish to change. This parameter relates to Content Matching Rules only. String PreProcPrecedencePos This parameter, in conjunction with the PreProcPrecedence parameter, is used to change the position of the rule in a sequence of rules. For example a position of 2 means the rule will be checked second. This parameter relates to the Content Matching Rules only. Int16 RequestPrecedence This parameter should be used in conjunction with RequestPrecedencePos. This parameter is used to specify the name of the existing request rule whose position you wish to change. This parameter relates to the following rule types: Content Matching Add Header Delete Header Replace Header Modify URL String RequestPrecedencePos This parameter, in conjunction with the RequestPrecedence parameter, is used to change the position of the rule in a sequence of rules. For example a position of 2 means the rule will be checked second. Int16 ResponsePrecedence This parameter should be used in conjunction with ResponsePrecedencePos. This parameter is used to specify the name of the existing response rule whose position you wish to change. This parameter relates to the following rule types: Content Matching Add Header Delete Header Replace Header String ResponsePrecedencePos This parameter, in conjunction with the ResponsePrecedence parameter, is used to change the position of the rule in a sequence of rules. For example, a position of 2 means the rule will be checked second. Int16 RsRulePrecedence This parameter should be used in conjunction with RSRulePrecedencePos. This parameter is used to specify the name of the existing rule whose position you wish to change. String RsRulePrecedencePos This parameter, in conjunction with the RSRulePrecedence parameter, is used to change the position of the rule in a sequence of rules. For example, a position of 2 means the rule will be checked second. Int16 NeedHostName When this parameter is enabled, the hostname is always required to be sent in the TLS client hello message. If it is not sent, the connection is dropped. Valid values: 0 - Disabled 1 - Enabled Boolean CopyHdrFrom This is the name of the source header field to copy into the new header field before the request is sent to the Real Servers. String CopyHdrTo This parameter is used in conjunction with the CopyHdrFrom parameter. The name of the header field into which the source header is to be copied. String ServerFbaPath Only relevant when using form-based authentication as the Server Authentication Mode (OutputAuthMode). Set the authentication path for server-side Form Based Authentication (FBA). When used in Exchange environments, this does not need to be set. String ServerFbaPost Only relevant when using form-based authentication as the Server Athentication Mode (OutputAuthMode). Set the format string used to generate POST body for server side FBA. The value must be base64-encoded. When used in Exchange environments, this does not need to be set. String Intercept Enable or disable the Web Application Firewall (WAF) for this Virtual Service. Boolean InterceptOpts Specifies Web Application Firewall (WAF) options for this Virtual Service. The AFP InterceptOpts parameter is a special parameter – it can be used to set the value for multiple fields, rather than just one field as with most other parameters. The InterceptOpts parameter allows the specification of most of the fields in the WAF Options section of the Virtual Service modify screen in the LoadMaster WUI. To enable WAF, set the Intercept parameter to 1. The names of the specific WUI fields that the InterceptOpts parameter is related to, are listed in the table below. One or more field values can be set in one command. Multiple values can be set in the one command by separating the values with a semi-colon. The values that are related to the same WUI option are mutually exclusive. For example, you cannot set Basic Operation to both opnormal and opblock. Value Related WUI Option Default Meaning opnormal Default Operation Audit Only Set the Basic Operation to Audit Only opblock Default Operation Audit Only Set the Basic Operation to Block Mode auditnone Audit mode No Audit Set the Audit mode to No Audit. No data is logged. auditrelevant Audit mode No Audit Set the Audit mode to Audit Relevant. Logs data which is of a warning level and higher. auditall Audit mode No Audit Set the Audit mode to Audit All. Logs all data through the Virtual Service. The Audit All option is not recommended for use in normal operation. Audit All should only be used when troubleshooting a specific problem. reqdataenable Inspect HTML POST Request Content Disabled Enable the Inspect HTML POST Request Content option reqdatadisable Inspect HTML POST Request Content Disabled Disable the Inspect HTML POST Request Content option resdataenable Process Response Data Disabled Enable the Process Response Data option resdatadisable Process Response Data Disabled Disable the Process Response Data option jsondisable Disable JSON Parser Disabled Disable the JSON parser. This option is only relevant if the Inspect HTML POST Request Content option is enabled. jsonenable Disable JSON Parser Disabled Enable the JSON parser. This option is only relevant if the Inspect HTML POST Request Content option is enabled. xmldisable Disable XML Parser Disabled Disable the XML parser. This option is only relevant if the Inspect HTML POST Request Content option is enabled. xmlenable Disable XML Parser Disabled Enable the XML parser. This option is only relevant if the Inspect HTML POST Request Content option is enabled. String InterceptRules Specifies Web Application Firewall (WAF) rules for this Virtual Service. String AlertThreshold Specifies Web Application Firewall (WAF) alert threshold for this Virtual Service Int32 Weight Specify the weight of this SubVS. Int32 Limit The maximum number of connections that can be sent to this SubVS before it is taken out of rotation from the main Virtual Service (the maximum limit is 100000). Int64 Critical Indicate that this SubVS is required for the Virtual Service to be available. Boolean LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Set-AdcSubVirtualService SubVSIndex The ID number of the SubVS to configure. Int32 AddVia Specifies which headers should be added to the HTTP stream. The parameter takes the following arguments: 0 = Legacy Operation 1 = X-Forwarded-For 2 = None 3 = X-Client-Side 4 = X-Client-Side No Via 5 = X-Forwarded-For No Via 6 = Via Only Int16 CheckType Specifies the protocol to use to check if the service is up. Valid options are "tcp", "icmp", "https", "http", "smtp", "nntp", "ftp", "telnet", "pop3", "imap", "rdp", "ldap" or "none". String CheckHost The address to use to check if the service is up. String CheckPattern A regular expression string that can be validate on a 200 reply to determine if the service is up. Specify an empty value to unset CheckPattern. String CheckUrl The URL to check if the service is up. The maximum character length for the CheckUrl parameter value is 126 characters. String CheckHeaders Specify up to four additional headers/fields which will be sent with each health check request. Separate the pairs with a pipe, for example; Host:xyc|UserAgent:prq. String LdapEndpoint Specify the LDAP endpoint to use for health checks (if LDAP is selected as the CheckType). If LDAP is selected as the health check protocol, the server IP address (or addresses) and ports from the LDAP endpoint configuration will be used instead of the Real Server IP address and port. String MatchLen This parameter is only relevant when the CheckType is set to "bdata". Specify the number of bytes to find the CheckPattern within. String CheckUse1_1 Specifies that the health checker use HTTP/1.1 instead of HTTP/1.0. Int32 CheckPort The port to use to check if the service is up. Specify 0 to unset CheckPort. Int32 EnhancedHealthChecks Enables or disables Enhanced Health Check Options for the Virtual Service. Boolean RsMinimum Specifies the minimum number of Real Servers that are required to be active for the Virtual Service to be considered up. Int32 Cookie Specifies a cookie name. This parameter is only relevant when the persistence mode is set to "cookie", "active-cookie", "cookie-src" or "active-cook-src". String Enable Enables or disables the Virtual Service. Boolean ErrorCode If no Real Servers are available, the LoadMaster can terminate the connection with an HTTP error code. Specify the error code number in this parameter. String ErrorUrl When no Real Servers are available and an error response is sent back to the client, a redirect URL can also be specified. String PortFollow This parameter was depreciated as of 7.1-24. For LoadMasters with version 7.1-24 or higher, use the FollowVSID parameter to set port following. Int32 ForceL7 Enabling ForceL7 means the Virtual Service runs at Layer 7 and not Layer 4. This may be needed for various reasons, including that only Layer 7 services can be non-transparent. Boolean Idletime Specifies the length of time (in seconds) that a connection may remain idle before it is closed. The range for this parameter is 0 to 86400. 0 means indefinitely. Int32 LocalBindAddresses Specifies a space-separated list of IP addresses. This corresponds to the Alternate Source Address in the Advanced Properties section of the WUI. Allow connections scaling over 64K Connections needs to be enabled in L7 Configuration for this feature to work. String[] VSType Specifies the type of service being load balanced: gen - Generic http - HTTP/HTTPS ts - Remote Terminal tls – STARTTLS protocols log – Log Insight String Nickname Specifies the "friendly" name of the service. In addition to the usual alphanumeric characters, the following "special" characters can be used as part of the Service Name: . @ - _ However, there must be at least one alphanumeric character before the special characters. String Persist Specifies the type of persistence (stickiness) to be used for this Virtual Service. The following persistence values are supported: ssl, cookie, active-cookie, cookie-src, active-cook-src, cookie-hash, cookie-hash-src, url, query-hash, host, header, super, super-src, src, rdp, rdp-src, rdp-sb, rdp-sb-src and none. Note: If setting the persistence mode to an option that requires a cookie (or query-hash), the cookie parameter must also be set. String PersistTimeout The length of time (in seconds) after the last connection that the LoadMaster will remember the persistence information. Timeout values are rounded down to an even number of minutes. Setting a value that is not a number of whole minutes results in the excess being ignored. Setting a value to less than 60 seconds results in a value of 0 being set, which disables persistency. Int32 QueryTag This is the query tag to be matched if the Persist type is set to query-hash. String Schedule Specifies the type of scheduling of new connections to Real Servers that is to be performed. The following values are supported: rr = round robin wrr = weighted round robin lc = least connection wlc = weighted least connection fixed = fixed weighting adaptive = resource based (adaptive) sh = source IP hash dl = weighted response time sdn-adaptive = resource based (SDN adaptive) String ServerInit Specifies one of the following values: 0 - Normal Protocols 1 - SMTP 2 - SSH 3 - Other Server Initiating 4 - IMAP4 5 - MySQL 6 - POP3 Int16 StandByAddr Specifies the IP address of the "Sorry" server that is to be used when no other Real Servers are available. This server will not be health checked and is assumed to be always available. String StandByPort Specifies the port of the "Sorry" server. String TransactionLimit This is a legacy parameter that should no longer be used. It was used previously when the SSL proxy was limited to 6K total connections. The transaction limit was used to limit one Virtual Service to only handle so many connections out of this 6K. On newer systems, where the limit is greater than 64K - this feature is no longer required. Int32 Transparent When using Layer 7, when this is enabled - the connection arriving at the Real Server appears to come directly from the client. Alternatively, the connection can be non-transparent which means that the connections at the Real Server appear to come from the LoadMaster. Boolean SubnetOriginating When transparency is not enabled, the source IP address of connections to the Real Servers is that of the Virtual Service. When transparency is enabled, the source IP address will be the IP address that is initiating connection to the Virtual Service. If the Real Server is on a subnet, and the Subnet Originating Requests option is enabled, then the subnet address of the LoadMaster will be used as the source IP address. Boolean QoS Specifies the Quality of Service. The following values are supported: 0 - Normal-Service 1 - Minimize-Cost 2 - Maximize-Reliability 4 - Maximize-Throughput 8 - Minimize-Delay String CheckUseGet When accessing the health check URL - the system can use the HEAD, the GET or the POST method: 0 - HEAD 1 - GET 2 - POST Int32 Verify Specifies a verification bitmask. The valid values of the Verify parameter are as follows: Bit 0: set this to 1 to enable detection intrusion. Note: Bit 0 needs to be set to 1 in order to use the other two bits. Bit 1: Determines whether to reject or drop a connection. Setting it to 1 will drop the connection. Bit 2: Determines whether to give just warnings on bad requests or also on malicious (but not invalid) requests. The following table lists the valid integers and the values they set the fields to when used: Integer Detect Malicious Requests Intrusion Handling Warnings Checkbox 0 Disabled N/A N/A 1 Enabled Drop Connection Unchecked 2 Enabled Send Reject Unchecked 3 Enabled Send Reject Unchecked 4 Enabled Drop Connection Checked 5 Enabled Drop Connection Checked 6 Enabled Send Reject Checked 7 Enabled Send Reject Checked Int16 ExtraHdrKey Specifies the key for the extra header to be inserted into every request sent to the Real Servers. String ExtraHdrValue Specifies the value for the extra header to be inserted into every request sent to the Real Servers. String AllowedHosts This parameter is only relevant when ESP is enabled. Specifies all the virtual hosts that can be accessed via this Virtual Service. String AllowedDirectories This parameter is only relevant when ESP is enabled. Specifies all the virtual directories that can be accessed via this Virtual Service. String AllowedGroups Specifies the groups that are allowed to access this Virtual Service. String GroupSIDs Specify the group SID(s) that are allowed to access this Virtual Service. Multiple SIDs can be separating them with a semicolon. String SteeringGroups Enter the Active Directory group names that will be used for steering traffic. Use a semi-colon to separate multiple group names. The steering group index number corresponds to the location of the group in this list. String IncludeNestedGroups Specify if nested groups should be included in the authentication attempt. Boolean DisplayPubPriv Display the public/private option on the login page. Based on the option the user selects on the login form, the session timeout value will be set to the value specified for either the public or private timeout. Boolean DisablePasswordForm Enabling this option removes the password field from the login page. This may be needed when password validation is not required, for example if using RSA SecurID authentication in a singular fashion. Boolean Domain Specifies the Single Sign On (SSO) domain in which this Virtual Service will operate. String AltDomains Specifies alternative domains to be assigned to a Virtual Service when configuring multi-domain authentication. To specify multiple alternative domains use a space-separated list. String Logoff This parameter is only relevant when ESP is enabled and when the Client Authentication Mode is set to Form Based. Specify the string that the LoadMaster should use to detect a logout event. Multiple logoff strings can be specified by using a space-separated list. If the URL to be matched contains sub-directories before the specified string, the Logoff String will not be matched. Therefore the LoadMaster will not log the user off. String ESPLogs Enable ESP logging. Valid values are below: 0 - Logging off 1 - User Access 2 - Security 3 - User Access and Security 4 - Connection 5 - User Access and Connection 6 - Security and connection 7 - User Access, Security and Connection Note: The only valid values for SMTP services are 0 and 4. For SMTP services, security issues are always logged. Nothing is logged for user access because there are no logins. Int16 SMTPAllowedDomains Specifies all the permitted domains that are allowed to be received by this Virtual Service. String ESPEnabled Specifies whether to enable or disable the Edge Security Pack (ESP) features. Boolean UserPwdChangeUrl This is relevant when using form-based or LDAP authentication. Specify the URL that users can use to change their password. If a user’s password has expired, or if they must reset their password, this URL and the UserPwdChangeMsg is displayed on the login form. This URL must be put into the exception list for authentication, if required. String UserPwdChangeMsg This parameter is only relevant if the UserPwdChangeURL parameter is set. Specify the text to be displayed on the login form when the user must reset their password. String SecurityHeaderOptions Int16 InputAuthMode Specifies the client authentication method to be used: 0 - Delegate to Server 1 - Basic Authentication 2 - Form Based 3 - KCD 4 - Client Certificate 5 - NTLM Int16 OutConf String OutputAuthMode Specifies the server authentication mode to be used: 0 - None 1 - Basic Authentication 2 - KCD Int16 StartTLSMode 0 - HTTP/HTTPS (the Service Type needs to be set to HTTP/HTTPS for this to work) The Virtual Service Type must be set to STARTTLS for the remaining values to be set: 1 - SMTP (STARTTLS if requested) 2 - SMTP (STARTTLS always) 3 - FTP 4 - IMAP 6 - POP3 Int16 MultiConnect Enabling this option permits the LoadMaster to manage connection handling between the LoadMaster and the Real Servers. Requests from multiple clients will be sent over the same TCP connection. Multiplexing only works for simple HTTP GET operations. This parameter cannot be enabled in certain situations, for example if WAF, ESP or SSL Acceleration is enabled. Boolean SingleSignOnDir This parameter relates to the SSO Image Set drop-down in the ESP Options section of the modify Virtual Service screen. Specify the name of the image set to be used for the login screen. If no image set is specified, the default Exchange image set will be used. String OCSPVerify Specifies whether to verify (via Online Certificate Status Protocol (OCSP)) that the client certificate is valid. String FollowVSID Specifies the ID of the Virtual Service to follow. Int32 TlsType Specify which of the following protocols to support; SSLv3, TLS1.0, TLS1.1 or TLS1.2. By default, TLS1.1 and TLS1.2 are enabled. The protocols can be enabled and disabled using a bitmask value. Refer to the table below to find out what number corresponds to which settings. Number.... SSLv3.... TLS1.0.... TLS1.1.... TLS1.2 0......... Enabled.. Enabled... Enabled... Enabled 1......... Disabled. Enabled... Enabled... Enabled 2......... Enabled.. Disabled.. Enabled... Enabled 3......... Disabled. Disabled.. Enabled... Enabled 4......... Enabled.. Enabled... Disabled.. Enabled 5......... Disabled. Enabled... Disabled.. Enabled 6......... Enabled.. Disabled.. Disabled.. Enabled 7......... Disabled. Disabled.. Disabled.. Enabled 8......... Enabled.. Enabled... Enabled... Disabled 9......... Disabled. Enabled... Enabled... Disabled 10........ Enabled.. Disabled.. Enabled... Disabled 11........ Disabled. Disabled.. Enabled... Disabled 12........ Enabled.. Enabled... Disabled.. Disabled 13........ Disabled. Enabled... Disabled.. Disabled 14........ Enabled.. Disabled.. Disabled.. Disabled Int32 CheckPostData This parameter is only relevant if the HTTP Method is set to POST. When using the POST method, up to 2047 characters of POST data can be sent to the server. String CheckCodes A space-separated list of HTTP status codes that should be treated as successful when received from the Real Server. Range: 300-599 String PreProcPrecedence This parameter should be used in conjunction with PreProcPrecedencePos. This parameter is used to specify the name of the existing rule whose position you wish to change. This parameter relates to Content Matching Rules only. String PreProcPrecedencePos This parameter, in conjunction with the PreProcPrecedence parameter, is used to change the position of the rule in a sequence of rules. For example a position of 2 means the rule will be checked second. This parameter relates to the Content Matching Rules only. Int16 RequestPrecedence This parameter should be used in conjunction with RequestPrecedencePos. This parameter is used to specify the name of the existing request rule whose position you wish to change. This parameter relates to the following rule types: Content Matching Add Header Delete Header Replace Header Modify URL String RequestPrecedencePos This parameter, in conjunction with the RequestPrecedence parameter, is used to change the position of the rule in a sequence of rules. For example a position of 2 means the rule will be checked second. Int16 ResponsePrecedence This parameter should be used in conjunction with ResponsePrecedencePos. This parameter is used to specify the name of the existing response rule whose position you wish to change. This parameter relates to the following rule types: Content Matching Add Header Delete Header Replace Header String ResponsePrecedencePos This parameter, in conjunction with the ResponsePrecedence parameter, is used to change the position of the rule in a sequence of rules. For example, a position of 2 means the rule will be checked second. Int16 RsRulePrecedence This parameter should be used in conjunction with RSRulePrecedencePos. This parameter is used to specify the name of the existing rule whose position you wish to change. String RsRulePrecedencePos This parameter, in conjunction with the RSRulePrecedence parameter, is used to change the position of the rule in a sequence of rules. For example, a position of 2 means the rule will be checked second. Int16 NeedHostName When this parameter is enabled, the hostname is always required to be sent in the TLS client hello message. If it is not sent, the connection is dropped. Valid values: 0 - Disabled 1 - Enabled Boolean CopyHdrFrom This is the name of the source header field to copy into the new header field before the request is sent to the Real Servers. String CopyHdrTo This parameter is used in conjunction with the CopyHdrFrom parameter. The name of the header field into which the source header is to be copied. String ServerFbaPath Only relevant when using form-based authentication as the Server Authentication Mode (OutputAuthMode). Set the authentication path for server-side Form Based Authentication (FBA). When used in Exchange environments, this does not need to be set. String ServerFbaPost Only relevant when using form-based authentication as the Server Athentication Mode (OutputAuthMode). Set the format string used to generate POST body for server side FBA. The value must be base64-encoded. When used in Exchange environments, this does not need to be set. String Intercept Enable or disable the Web Application Firewall (WAF) for this Virtual Service. Boolean InterceptOpts Specifies Web Application Firewall (WAF) options for this Virtual Service. The AFP InterceptOpts parameter is a special parameter – it can be used to set the value for multiple fields, rather than just one field as with most other parameters. The InterceptOpts parameter allows the specification of most of the fields in the WAF Options section of the Virtual Service modify screen in the LoadMaster WUI. To enable WAF, set the Intercept parameter to 1. The names of the specific WUI fields that the InterceptOpts parameter is related to, are listed in the table below. One or more field values can be set in one command. Multiple values can be set in the one command by separating the values with a semi-colon. The values that are related to the same WUI option are mutually exclusive. For example, you cannot set Basic Operation to both opnormal and opblock. Value Related WUI Option Default Meaning opnormal Default Operation Audit Only Set the Basic Operation to Audit Only opblock Default Operation Audit Only Set the Basic Operation to Block Mode auditnone Audit mode No Audit Set the Audit mode to No Audit. No data is logged. auditrelevant Audit mode No Audit Set the Audit mode to Audit Relevant. Logs data which is of a warning level and higher. auditall Audit mode No Audit Set the Audit mode to Audit All. Logs all data through the Virtual Service. The Audit All option is not recommended for use in normal operation. Audit All should only be used when troubleshooting a specific problem. reqdataenable Inspect HTML POST Request Content Disabled Enable the Inspect HTML POST Request Content option reqdatadisable Inspect HTML POST Request Content Disabled Disable the Inspect HTML POST Request Content option resdataenable Process Response Data Disabled Enable the Process Response Data option resdatadisable Process Response Data Disabled Disable the Process Response Data option jsondisable Disable JSON Parser Disabled Disable the JSON parser. This option is only relevant if the Inspect HTML POST Request Content option is enabled. jsonenable Disable JSON Parser Disabled Enable the JSON parser. This option is only relevant if the Inspect HTML POST Request Content option is enabled. xmldisable Disable XML Parser Disabled Disable the XML parser. This option is only relevant if the Inspect HTML POST Request Content option is enabled. xmlenable Disable XML Parser Disabled Enable the XML parser. This option is only relevant if the Inspect HTML POST Request Content option is enabled. String InterceptRules Specifies Web Application Firewall (WAF) rules for this Virtual Service. String AlertThreshold Specifies Web Application Firewall (WAF) alert threshold for this Virtual Service Int32 Weight Specify the weight of this SubVS. Int32 Limit The maximum number of connections that can be sent to this SubVS before it is taken out of rotation from the main Virtual Service (the maximum limit is 100000). Int64 Critical Indicate that this SubVS is required for the Virtual Service to be available. Boolean LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String SubVSIndex The ID number of the SubVS to configure. Int32 Int32 AddVia Specifies which headers should be added to the HTTP stream. The parameter takes the following arguments: 0 = Legacy Operation 1 = X-Forwarded-For 2 = None 3 = X-Client-Side 4 = X-Client-Side No Via 5 = X-Forwarded-For No Via 6 = Via Only Int16 Int16 CheckType Specifies the protocol to use to check if the service is up. Valid options are "tcp", "icmp", "https", "http", "smtp", "nntp", "ftp", "telnet", "pop3", "imap", "rdp", "ldap" or "none". String String CheckHost The address to use to check if the service is up. String String CheckPattern A regular expression string that can be validate on a 200 reply to determine if the service is up. Specify an empty value to unset CheckPattern. String String CheckUrl The URL to check if the service is up. The maximum character length for the CheckUrl parameter value is 126 characters. String String CheckHeaders Specify up to four additional headers/fields which will be sent with each health check request. Separate the pairs with a pipe, for example; Host:xyc|UserAgent:prq. String String LdapEndpoint Specify the LDAP endpoint to use for health checks (if LDAP is selected as the CheckType). If LDAP is selected as the health check protocol, the server IP address (or addresses) and ports from the LDAP endpoint configuration will be used instead of the Real Server IP address and port. String String MatchLen This parameter is only relevant when the CheckType is set to "bdata". Specify the number of bytes to find the CheckPattern within. String String CheckUse1_1 Specifies that the health checker use HTTP/1.1 instead of HTTP/1.0. Int32 Int32 CheckPort The port to use to check if the service is up. Specify 0 to unset CheckPort. Int32 Int32 EnhancedHealthChecks Enables or disables Enhanced Health Check Options for the Virtual Service. Boolean Boolean RsMinimum Specifies the minimum number of Real Servers that are required to be active for the Virtual Service to be considered up. Int32 Int32 Cookie Specifies a cookie name. This parameter is only relevant when the persistence mode is set to "cookie", "active-cookie", "cookie-src" or "active-cook-src". String String Enable Enables or disables the Virtual Service. Boolean Boolean ErrorCode If no Real Servers are available, the LoadMaster can terminate the connection with an HTTP error code. Specify the error code number in this parameter. String String ErrorUrl When no Real Servers are available and an error response is sent back to the client, a redirect URL can also be specified. String String PortFollow This parameter was depreciated as of 7.1-24. For LoadMasters with version 7.1-24 or higher, use the FollowVSID parameter to set port following. Int32 Int32 ForceL7 Enabling ForceL7 means the Virtual Service runs at Layer 7 and not Layer 4. This may be needed for various reasons, including that only Layer 7 services can be non-transparent. Boolean Boolean Idletime Specifies the length of time (in seconds) that a connection may remain idle before it is closed. The range for this parameter is 0 to 86400. 0 means indefinitely. Int32 Int32 LocalBindAddresses Specifies a space-separated list of IP addresses. This corresponds to the Alternate Source Address in the Advanced Properties section of the WUI. Allow connections scaling over 64K Connections needs to be enabled in L7 Configuration for this feature to work. String[] String[] VSType Specifies the type of service being load balanced: gen - Generic http - HTTP/HTTPS ts - Remote Terminal tls – STARTTLS protocols log – Log Insight String String Nickname Specifies the "friendly" name of the service. In addition to the usual alphanumeric characters, the following "special" characters can be used as part of the Service Name: . @ - _ However, there must be at least one alphanumeric character before the special characters. String String Persist Specifies the type of persistence (stickiness) to be used for this Virtual Service. The following persistence values are supported: ssl, cookie, active-cookie, cookie-src, active-cook-src, cookie-hash, cookie-hash-src, url, query-hash, host, header, super, super-src, src, rdp, rdp-src, rdp-sb, rdp-sb-src and none. Note: If setting the persistence mode to an option that requires a cookie (or query-hash), the cookie parameter must also be set. String String PersistTimeout The length of time (in seconds) after the last connection that the LoadMaster will remember the persistence information. Timeout values are rounded down to an even number of minutes. Setting a value that is not a number of whole minutes results in the excess being ignored. Setting a value to less than 60 seconds results in a value of 0 being set, which disables persistency. Int32 Int32 QueryTag This is the query tag to be matched if the Persist type is set to query-hash. String String Schedule Specifies the type of scheduling of new connections to Real Servers that is to be performed. The following values are supported: rr = round robin wrr = weighted round robin lc = least connection wlc = weighted least connection fixed = fixed weighting adaptive = resource based (adaptive) sh = source IP hash dl = weighted response time sdn-adaptive = resource based (SDN adaptive) String String ServerInit Specifies one of the following values: 0 - Normal Protocols 1 - SMTP 2 - SSH 3 - Other Server Initiating 4 - IMAP4 5 - MySQL 6 - POP3 Int16 Int16 StandByAddr Specifies the IP address of the "Sorry" server that is to be used when no other Real Servers are available. This server will not be health checked and is assumed to be always available. String String StandByPort Specifies the port of the "Sorry" server. String String TransactionLimit This is a legacy parameter that should no longer be used. It was used previously when the SSL proxy was limited to 6K total connections. The transaction limit was used to limit one Virtual Service to only handle so many connections out of this 6K. On newer systems, where the limit is greater than 64K - this feature is no longer required. Int32 Int32 Transparent When using Layer 7, when this is enabled - the connection arriving at the Real Server appears to come directly from the client. Alternatively, the connection can be non-transparent which means that the connections at the Real Server appear to come from the LoadMaster. Boolean Boolean SubnetOriginating When transparency is not enabled, the source IP address of connections to the Real Servers is that of the Virtual Service. When transparency is enabled, the source IP address will be the IP address that is initiating connection to the Virtual Service. If the Real Server is on a subnet, and the Subnet Originating Requests option is enabled, then the subnet address of the LoadMaster will be used as the source IP address. Boolean Boolean QoS Specifies the Quality of Service. The following values are supported: 0 - Normal-Service 1 - Minimize-Cost 2 - Maximize-Reliability 4 - Maximize-Throughput 8 - Minimize-Delay String String CheckUseGet When accessing the health check URL - the system can use the HEAD, the GET or the POST method: 0 - HEAD 1 - GET 2 - POST Int32 Int32 Verify Specifies a verification bitmask. The valid values of the Verify parameter are as follows: Bit 0: set this to 1 to enable detection intrusion. Note: Bit 0 needs to be set to 1 in order to use the other two bits. Bit 1: Determines whether to reject or drop a connection. Setting it to 1 will drop the connection. Bit 2: Determines whether to give just warnings on bad requests or also on malicious (but not invalid) requests. The following table lists the valid integers and the values they set the fields to when used: Integer Detect Malicious Requests Intrusion Handling Warnings Checkbox 0 Disabled N/A N/A 1 Enabled Drop Connection Unchecked 2 Enabled Send Reject Unchecked 3 Enabled Send Reject Unchecked 4 Enabled Drop Connection Checked 5 Enabled Drop Connection Checked 6 Enabled Send Reject Checked 7 Enabled Send Reject Checked Int16 Int16 ExtraHdrKey Specifies the key for the extra header to be inserted into every request sent to the Real Servers. String String ExtraHdrValue Specifies the value for the extra header to be inserted into every request sent to the Real Servers. String String AllowedHosts This parameter is only relevant when ESP is enabled. Specifies all the virtual hosts that can be accessed via this Virtual Service. String String AllowedDirectories This parameter is only relevant when ESP is enabled. Specifies all the virtual directories that can be accessed via this Virtual Service. String String AllowedGroups Specifies the groups that are allowed to access this Virtual Service. String String GroupSIDs Specify the group SID(s) that are allowed to access this Virtual Service. Multiple SIDs can be separating them with a semicolon. String String SteeringGroups Enter the Active Directory group names that will be used for steering traffic. Use a semi-colon to separate multiple group names. The steering group index number corresponds to the location of the group in this list. String String IncludeNestedGroups Specify if nested groups should be included in the authentication attempt. Boolean Boolean DisplayPubPriv Display the public/private option on the login page. Based on the option the user selects on the login form, the session timeout value will be set to the value specified for either the public or private timeout. Boolean Boolean DisablePasswordForm Enabling this option removes the password field from the login page. This may be needed when password validation is not required, for example if using RSA SecurID authentication in a singular fashion. Boolean Boolean Domain Specifies the Single Sign On (SSO) domain in which this Virtual Service will operate. String String AltDomains Specifies alternative domains to be assigned to a Virtual Service when configuring multi-domain authentication. To specify multiple alternative domains use a space-separated list. String String Logoff This parameter is only relevant when ESP is enabled and when the Client Authentication Mode is set to Form Based. Specify the string that the LoadMaster should use to detect a logout event. Multiple logoff strings can be specified by using a space-separated list. If the URL to be matched contains sub-directories before the specified string, the Logoff String will not be matched. Therefore the LoadMaster will not log the user off. String String ESPLogs Enable ESP logging. Valid values are below: 0 - Logging off 1 - User Access 2 - Security 3 - User Access and Security 4 - Connection 5 - User Access and Connection 6 - Security and connection 7 - User Access, Security and Connection Note: The only valid values for SMTP services are 0 and 4. For SMTP services, security issues are always logged. Nothing is logged for user access because there are no logins. Int16 Int16 SMTPAllowedDomains Specifies all the permitted domains that are allowed to be received by this Virtual Service. String String ESPEnabled Specifies whether to enable or disable the Edge Security Pack (ESP) features. Boolean Boolean UserPwdChangeUrl This is relevant when using form-based or LDAP authentication. Specify the URL that users can use to change their password. If a user’s password has expired, or if they must reset their password, this URL and the UserPwdChangeMsg is displayed on the login form. This URL must be put into the exception list for authentication, if required. String String UserPwdChangeMsg This parameter is only relevant if the UserPwdChangeURL parameter is set. Specify the text to be displayed on the login form when the user must reset their password. String String SecurityHeaderOptions Int16 Int16 InputAuthMode Specifies the client authentication method to be used: 0 - Delegate to Server 1 - Basic Authentication 2 - Form Based 3 - KCD 4 - Client Certificate 5 - NTLM Int16 Int16 OutConf String String OutputAuthMode Specifies the server authentication mode to be used: 0 - None 1 - Basic Authentication 2 - KCD Int16 Int16 StartTLSMode 0 - HTTP/HTTPS (the Service Type needs to be set to HTTP/HTTPS for this to work) The Virtual Service Type must be set to STARTTLS for the remaining values to be set: 1 - SMTP (STARTTLS if requested) 2 - SMTP (STARTTLS always) 3 - FTP 4 - IMAP 6 - POP3 Int16 Int16 MultiConnect Enabling this option permits the LoadMaster to manage connection handling between the LoadMaster and the Real Servers. Requests from multiple clients will be sent over the same TCP connection. Multiplexing only works for simple HTTP GET operations. This parameter cannot be enabled in certain situations, for example if WAF, ESP or SSL Acceleration is enabled. Boolean Boolean SingleSignOnDir This parameter relates to the SSO Image Set drop-down in the ESP Options section of the modify Virtual Service screen. Specify the name of the image set to be used for the login screen. If no image set is specified, the default Exchange image set will be used. String String OCSPVerify Specifies whether to verify (via Online Certificate Status Protocol (OCSP)) that the client certificate is valid. String String FollowVSID Specifies the ID of the Virtual Service to follow. Int32 Int32 TlsType Specify which of the following protocols to support; SSLv3, TLS1.0, TLS1.1 or TLS1.2. By default, TLS1.1 and TLS1.2 are enabled. The protocols can be enabled and disabled using a bitmask value. Refer to the table below to find out what number corresponds to which settings. Number.... SSLv3.... TLS1.0.... TLS1.1.... TLS1.2 0......... Enabled.. Enabled... Enabled... Enabled 1......... Disabled. Enabled... Enabled... Enabled 2......... Enabled.. Disabled.. Enabled... Enabled 3......... Disabled. Disabled.. Enabled... Enabled 4......... Enabled.. Enabled... Disabled.. Enabled 5......... Disabled. Enabled... Disabled.. Enabled 6......... Enabled.. Disabled.. Disabled.. Enabled 7......... Disabled. Disabled.. Disabled.. Enabled 8......... Enabled.. Enabled... Enabled... Disabled 9......... Disabled. Enabled... Enabled... Disabled 10........ Enabled.. Disabled.. Enabled... Disabled 11........ Disabled. Disabled.. Enabled... Disabled 12........ Enabled.. Enabled... Disabled.. Disabled 13........ Disabled. Enabled... Disabled.. Disabled 14........ Enabled.. Disabled.. Disabled.. Disabled Int32 Int32 CheckPostData This parameter is only relevant if the HTTP Method is set to POST. When using the POST method, up to 2047 characters of POST data can be sent to the server. String String CheckCodes A space-separated list of HTTP status codes that should be treated as successful when received from the Real Server. Range: 300-599 String String PreProcPrecedence This parameter should be used in conjunction with PreProcPrecedencePos. This parameter is used to specify the name of the existing rule whose position you wish to change. This parameter relates to Content Matching Rules only. String String PreProcPrecedencePos This parameter, in conjunction with the PreProcPrecedence parameter, is used to change the position of the rule in a sequence of rules. For example a position of 2 means the rule will be checked second. This parameter relates to the Content Matching Rules only. Int16 Int16 RequestPrecedence This parameter should be used in conjunction with RequestPrecedencePos. This parameter is used to specify the name of the existing request rule whose position you wish to change. This parameter relates to the following rule types: Content Matching Add Header Delete Header Replace Header Modify URL String String RequestPrecedencePos This parameter, in conjunction with the RequestPrecedence parameter, is used to change the position of the rule in a sequence of rules. For example a position of 2 means the rule will be checked second. Int16 Int16 ResponsePrecedence This parameter should be used in conjunction with ResponsePrecedencePos. This parameter is used to specify the name of the existing response rule whose position you wish to change. This parameter relates to the following rule types: Content Matching Add Header Delete Header Replace Header String String ResponsePrecedencePos This parameter, in conjunction with the ResponsePrecedence parameter, is used to change the position of the rule in a sequence of rules. For example, a position of 2 means the rule will be checked second. Int16 Int16 RsRulePrecedence This parameter should be used in conjunction with RSRulePrecedencePos. This parameter is used to specify the name of the existing rule whose position you wish to change. String String RsRulePrecedencePos This parameter, in conjunction with the RSRulePrecedence parameter, is used to change the position of the rule in a sequence of rules. For example, a position of 2 means the rule will be checked second. Int16 Int16 NeedHostName When this parameter is enabled, the hostname is always required to be sent in the TLS client hello message. If it is not sent, the connection is dropped. Valid values: 0 - Disabled 1 - Enabled Boolean Boolean CopyHdrFrom This is the name of the source header field to copy into the new header field before the request is sent to the Real Servers. String String CopyHdrTo This parameter is used in conjunction with the CopyHdrFrom parameter. The name of the header field into which the source header is to be copied. String String ServerFbaPath Only relevant when using form-based authentication as the Server Authentication Mode (OutputAuthMode). Set the authentication path for server-side Form Based Authentication (FBA). When used in Exchange environments, this does not need to be set. String String ServerFbaPost Only relevant when using form-based authentication as the Server Athentication Mode (OutputAuthMode). Set the format string used to generate POST body for server side FBA. The value must be base64-encoded. When used in Exchange environments, this does not need to be set. String String Intercept Enable or disable the Web Application Firewall (WAF) for this Virtual Service. Boolean Boolean InterceptOpts Specifies Web Application Firewall (WAF) options for this Virtual Service. The AFP InterceptOpts parameter is a special parameter – it can be used to set the value for multiple fields, rather than just one field as with most other parameters. The InterceptOpts parameter allows the specification of most of the fields in the WAF Options section of the Virtual Service modify screen in the LoadMaster WUI. To enable WAF, set the Intercept parameter to 1. The names of the specific WUI fields that the InterceptOpts parameter is related to, are listed in the table below. One or more field values can be set in one command. Multiple values can be set in the one command by separating the values with a semi-colon. The values that are related to the same WUI option are mutually exclusive. For example, you cannot set Basic Operation to both opnormal and opblock. Value Related WUI Option Default Meaning opnormal Default Operation Audit Only Set the Basic Operation to Audit Only opblock Default Operation Audit Only Set the Basic Operation to Block Mode auditnone Audit mode No Audit Set the Audit mode to No Audit. No data is logged. auditrelevant Audit mode No Audit Set the Audit mode to Audit Relevant. Logs data which is of a warning level and higher. auditall Audit mode No Audit Set the Audit mode to Audit All. Logs all data through the Virtual Service. The Audit All option is not recommended for use in normal operation. Audit All should only be used when troubleshooting a specific problem. reqdataenable Inspect HTML POST Request Content Disabled Enable the Inspect HTML POST Request Content option reqdatadisable Inspect HTML POST Request Content Disabled Disable the Inspect HTML POST Request Content option resdataenable Process Response Data Disabled Enable the Process Response Data option resdatadisable Process Response Data Disabled Disable the Process Response Data option jsondisable Disable JSON Parser Disabled Disable the JSON parser. This option is only relevant if the Inspect HTML POST Request Content option is enabled. jsonenable Disable JSON Parser Disabled Enable the JSON parser. This option is only relevant if the Inspect HTML POST Request Content option is enabled. xmldisable Disable XML Parser Disabled Disable the XML parser. This option is only relevant if the Inspect HTML POST Request Content option is enabled. xmlenable Disable XML Parser Disabled Enable the XML parser. This option is only relevant if the Inspect HTML POST Request Content option is enabled. String String InterceptRules Specifies Web Application Firewall (WAF) rules for this Virtual Service. String String AlertThreshold Specifies Web Application Firewall (WAF) alert threshold for this Virtual Service Int32 Int32 Weight Specify the weight of this SubVS. Int32 Int32 Limit The maximum number of connections that can be sent to this SubVS before it is taken out of rotation from the main Virtual Service (the maximum limit is 100000). Int64 Int64 Critical Indicate that this SubVS is required for the Virtual Service to be available. Boolean Boolean LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String AllowHTTP2 Enable HTTP2 for this Virtual Service. SSL Acceleration must be enabled before HTTP2 can be enabled. The Best Practices cipher set should be used when HTTP2 is enabled. boolean boolean -------------------------- Example -------------------------- PS C:\> Set-AdcSubVirtualService -SubVSIndex 3 -CheckType http Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Data field...: @{VS=} Param........: @{Status=Down; Index=3; VSPort=0; Layer=7; Enable=Y; SSLReverse=N; SSLReencrypt=N; Intercept=N; InterceptOpts=; AlertThreshold=0; Transac tionlimit=0; Transparent=N; SubnetOriginating=Y; ServerInit=0; StartTLSMode=0; Idletime=660; Cache=N; Compress=N; Verify=0; UseforSnat=N; ForceL4=N; For ceL7=Y; MultiConnect=N; ClientCert=0; ErrorCode=0; CheckUse1.1=N; MatchLen=0; CheckUseGet=0; SSLRewrite=0; VStype=http; FollowVSID=0; Protocol=tcp; Sche dule=rr; CheckType=http; PersistTimeout=0; CheckPort=0; NRules=0; NRequestRules=0; NResponseRules=0; NPreProcessRules=0; EspEnabled=N; InputAuthMode=0; OutputAuthMode=0; MasterVS=0; MasterVSID=1; IsTransparent=2; AddVia=0; QoS=0; TlsType=0; NeedHostName=N; OCSPVerify=N; AllowHTTP2=N; EnhancedHealthCheck s=N; RsMinimum=0; NumberOfRSs=0} Set-AdcVirtualService Set options on a configured Virtual Service. Set AdcVirtualService Modifies the settings for a configured Virtual Service. Set-AdcVirtualService VirtualService The IP address for the Virtual Service. String VSPort The port for the Virtual Service. The port parameter is used to assign a port when initially creating a Virtual Service. If modifying the port of an existing Virtual Service, specify the existing port as the Port parameter and use the VSPort parameter to assign the new port. The reason why these must be separate parameters is because you need to specify what the port of the existing Virtual Service is (because there may be another Virtual Service with the same IP address but a different port) and if you want to change the port, a second port parameter (VSPort) is needed to specify the new port value. Int32 VSProtocol The protocol of the relevant Virtual Service. String VSIndex The index number of the Virtual Service. Int32 AddVia Specifies which headers are added to the HTTP stream. Choose the number of the option to use. 0 - Legacy Operation(XXX) 1 - None 2 - X-Forwarded-For 3 - X-Forwarded-For (No Via) 4 - X-ClientSide 5 - X-ClientSide (No Via) 6 - Via Only Int16 Cache Enables or disables caching on this Virtual Service. Boolean CertFile Specifies the name of the certificate file to use that is already installed on the load balancer. Note: This will NOT upload a certificate file to the load balancer. String CheckType Specifies the protocol to use to check if the service is up. Valid options are "tcp", "icmp", "https", "http", "smtp", "nntp", "ftp", "telnet", "pop3", "imap", "rdp", "ldap" or "none". String CheckHost The address to use to check if the service is up. String CheckPattern A regular expression string that can be validate on a 200 reply to determine if the service is up. Specify an empty value to unset CheckPattern. String CheckUrl The URL to check if the service is up. The maximum character length for the CheckUrl parameter value is 126 characters. String CheckHeaders Specify up to four additional headers/fields which will be sent with each health check request. Separate the pairs with a pipe, for example; Host:xyc|UserAgent:prq. String LdapEndpoint Specify the LDAP endpoint to use for health checks (if LDAP is selected as the CheckType). If LDAP is selected as the health check protocol, the server IP address (or addresses) and ports from the LDAP endpoint configuration will be used instead of the Real Server IP address and port. String MatchLen This parameter is only relevant when the CheckType is set to "bdata". Specify the number of bytes to find the CheckPattern within. String CheckUse1_1 Specifies that the health checker use HTTP/1.1 instead of HTTP/1.0. 0 - HTTP/1.0 1 - HTTP/1.1 Int32 CheckPort The port to use to check if the service is up. Specify 0 to unset CheckPort. Int32 EnhancedHealthChecks Enables or disables Enhanced Health Check Options for the Virtual Service. Boolean RsMinimum Specifies the minimum number of Real Servers that are required to be active for the Virtual Service to be considered up. Int32 ClientCert Specify how client certificates should be used. Valid values are 0, 1, or 2. Zero indicates that client certificates are not use. One indicates that client certificates are required. Two indicates that client certificates are required and additional HEAD information is being sent. Int16 Compress Enable or disable file compression for the Virtual Service. Boolean Cookie Specifies a cookie name. This parameter is only relevant when the persistence mode is set to "cookie", "active-cookie", "cookie-src" or "active-cook-src". String CachePercent Specifies the maximum cache usage for this virtual service. Note: Setting two Virtual Services using 50% of cache will use 100% of all cache storage. This parameter accepts values from 0 to 100. Int16 DefaultGW Specifies a Virtual Service-specific default gateway to be used to send responses back to clients. If not set, the global default gateway will be used. String Enable Enables or disables the Virtual Service. Boolean ErrorCode If no Real Servers are available, the LoadMaster can terminate the connection with an HTTP error code. Specify the error code number in this parameter. String ErrorUrl When no Real Servers are available and an error response is sent back to the client, a redirect URL can also be specified. String PortFollow This parameter was depreciated as of 7.1-24. For LoadMasters with version 7.1-24 or higher, use the FollowVSID parameter to set port following. Int32 ForceL7 Enabling ForceL7 means the Virtual Service runs at Layer 7 and not Layer 4. This may be needed for various reasons, including that only Layer 7 services can be non-transparent. Boolean Idletime Specifies the length of time (in seconds) that a connection may remain idle before it is closed. The range for this parameter is 0 to 86400. There are some special values that can be set for this parameter: - 0: Ensures the default L7 connection timeout is used. The default timeout value can be modified by setting the conntimeout parameter. - 1: Discards the connection after the packet is first forwarded – a response is not expected or handled. - 2: Uses a DNS-type of operation. The connection is dropped after the reply message. Setting it to 1 or 2 enables better performance and memory usage for UDP connections and they correspond better to how UDP is used. Int32 LocalBindAddresses Specifies a space-separated list of IP addresses. This corresponds to the Alternate Source Address in the Advanced Properties section of the WUI. Allow connections scaling over 64K Connections needs to be enabled in L7 Configuration for this feature to work. String[] VSType Specifies the type of service being load balanced: gen - Generic http - HTTP/HTTPS ts - Remote Terminal tls – STARTTLS protocols log – Log Insight String Nickname Specifies the "friendly" name of the service. In addition to the usual alphanumeric characters, the following "special" characters can be used as part of the Service Name: . @ - _ However, there must be at least one alphanumeric character before the special characters. String Persist Specifies the type of persistence (stickiness) to be used for this Virtual Service. The following persistence values are supported: ssl, cookie, active-cookie, cookie-src, active-cook-src, cookie-hash, cookie-hash-src, url, query-hash, host, header, super, super-src, src, rdp, rdp-src, rdp-sb, rdp-sb-src, udpsip and none. Note: If setting the persistence mode to an option that requires a cookie (or query-hash), the cookie parameter must also be set. String PersistTimeout The length of time (in seconds) after the last connection that the LoadMaster will remember the persistence information. Timeout values are rounded down to an even number of minutes. Setting a value that is not a number of whole minutes results in the excess being ignored. Setting a value to less than 60 seconds results in a value of 0 being set, which disables persistency. Int32 QueryTag This is the query tag to be matched if the Persist type is set to query-hash. String CipherSet Specifies a cipher set name. String SSLReencrypt This parameter is only relevant if SSL Acceleration is enabled. When this option is enabled, the SSL data stream is re-encrypted before sending to the Real Server. Boolean SSLReverse Enabling this parameter means that the data from the LoadMaster to the Real Server is re-encrypted. Boolean SSLRewrite When the Real Server rejects a request with an HTTP redirect, the requesting Location URL may need to be converted to specify HTTPS instead of HTTP (and vice versa). String ReverseSNIHostname If this option is enabled, the host name is required to be sent in the TLS client hello message. If it is not sent the connection will be dropped. String Schedule Specifies the type of scheduling of new connections to Real Servers that is to be performed. The following values are supported: rr = round robin wrr = weighted round robin lc = least connection wlc = weighted least connection fixed = fixed weighting adaptive = resource based (adaptive) sh = source IP hash dl = weighted response time sdn-adaptive = resource based (SDN adaptive) String ServerInit Specifies one of the following values: 0 - Normal Protocols 1 - SMTP 2 - SSH 3 - Other Server Initiating 4 - IMAP4 5 - MySQL 6 - POP3 Int16 SSLAcceleration Specifies whether to enable SSL handling on the Virtual Service. Boolean StandByAddr Specifies the IP address of the "Sorry" server that is to be used when no other Real Servers are available. This server will not be health checked and is assumed to be always available. String StandByPort Specifies the port of the "Sorry" server. String TransactionLimit This is a legacy parameter that should no longer be used. It was used previously when the SSL proxy was limited to 6K total connections. The transaction limit was used to limit one Virtual Service to only handle so many connections out of this 6K. On newer systems, where the limit is greater than 64K - this feature is no longer required. Int32 Transparent When using Layer 7, when this is enabled - the connection arriving at the Real Server appears to come directly from the client. Alternatively, the connection can be non-transparent, which means that the connections at the Real Server appear to come from the LoadMaster. 0 - Disabled 1 - Enabled If a Virtual Service (with or without a SubVS) has SSL re-encrypt enabled, the transparency flag of the Virtual Service has no meaning (re-encryption forces transparency to be off). The transparency setting can still be modified by the API, and is honored when re-encrypt is disabled on the Virtual Service. Boolean SubnetOriginating When transparency is not enabled, the source IP address of connections to the Real Servers is that of the Virtual Service. When transparency is enabled, the source IP address will be the IP address that is initiating connection to the Virtual Service. If the Real Server is on a subnet, and the Subnet Originating Requests option is enabled, then the subnet address of the LoadMaster will be used as the source IP address. Boolean UseforSnat By default, when the LoadMaster is being used to NAT Real Servers, the source IP address used on the Internet is that of the LoadMaster. Enabling this option allows the Real Servers configured to use the Virtual Service as the source IP address instead. If the Real Servers are configured on more than one Virtual Service which has this option set, only connections to destination port 80 will use this Virtual Service as the source IP address. Boolean QoS Specifies the Quality of Service. The following values are supported: 0 - Normal-Service 1 - Minimize-Cost 2 - Maximize-Reliability 4 - Maximize-Throughput 8 - Minimize-Delay String CheckUseGet When accessing the health check URL - the system can use the HEAD, the GET or the POST method: 0 - HEAD 1 - GET 2 - POST Int32 Verify Specifies a verification bitmask. The valid values of the Verify parameter are as follows: Bit 0: set this to 1 to enable detection intrusion. Note: Bit 0 needs to be set to 1 in order to use the other two bits. Bit 1: Determines whether to reject or drop a connection. Setting it to 1 will drop the connection. Bit 2: Determines whether to give just warnings on bad requests or also on malicious (but not invalid) requests. The following table lists the valid integers and the values they set the fields to when used: Integer Detect Malicious Requests Intrusion Handling Warnings Checkbox 0 Disabled N/A N/A 1 Enabled Drop Connection Unchecked 2 Enabled Send Reject Unchecked 3 Enabled Send Reject Unchecked 4 Enabled Drop Connection Checked 5 Enabled Drop Connection Checked 6 Enabled Send Reject Checked 7 Enabled Send Reject Checked Int16 ExtraHdrKey Specifies the key for the extra header to be inserted into every request sent to the Real Servers. String ExtraHdrValue Specifies the value for the extra header to be inserted into every request sent to the Real Servers. String AllowedHosts This parameter is only relevant when ESP is enabled. Specifies all the virtual hosts that can be accessed via this Virtual Service. String AllowedDirectories This parameter is only relevant when ESP is enabled. Specifies all the virtual directories that can be accessed via this Virtual Service. String AllowedGroups Specifies the groups that are allowed to access this Virtual Service. String GroupSIDs Specify the group security identifiers (SIDs) that are allowed to access this Virtual Service. Each group must be separated by a semicolon. String SteeringGroups Enter the Active Directory group names that will be used for steering traffic. Use a semi-colon to separate multiple group names. The steering group index number corresponds to the location of the group in this list. String IncludeNestedGroups Specify if nested groups should be included in the authentication attempt. Boolean DisplayPubPriv Display the public/private option on the login page. Based on the option the user selects on the login form, the session timeout value will be set to the value specified for either the public or private timeout. Boolean DisablePasswordForm Enabling this option removes the password field from the login page. This may be needed when password validation is not required, for example if using RSA SecurID authentication in a singular fashion. Boolean Domain Specifies the Single Sign On (SSO) domain in which this Virtual Service will operate. String AltDomains Specifies alternative domains to be assigned to a Virtual Service when configuring multi-domain authentication. To specify multiple alternative domains use a space-separated list. String Logoff This parameter is only relevant when ESP is enabled and when the Client Authentication Mode is set to Form Based. Specify the string that the LoadMaster should use to detect a logout event. Multiple logoff strings can be specified by using a space-separated list. If the URL to be matched contains sub-directories before the specified string, the Logoff String will not be matched. Therefore the LoadMaster will not log the user off. String ESPLogs Enable ESP logging. Valid values are below: 0 - Logging off 1 - User Access 2 - Security 3 - User Access and Security 4 - Connection 5 - User Access and Connection 6 - Security and connection 7 - User Access, Security and Connection Note: The only valid values for SMTP services are 0 and 4. For SMTP services, security issues are always logged. Nothing is logged for user access because there are no logins. Int16 SMTPAllowedDomains Specifies all the permitted domains that are allowed to be received by this Virtual Service. String ESPEnabled Specifies whether to enable or disable the Edge Security Pack (ESP) features. Boolean UserPwdChangeUrl This is relevant when using form-based LDAP authentication. Specify the URL that users can use to change their password. If a user’s password has expired, or if they must reset their password, this URL and the UserPwdChangeMsg is displayed on the login form. This URL must be put into the exception list for authentication, if required. String UserPwdChangeMsg This parameter is only relevant if the UserPwdChangeURL parameter is set. Specify the text to be displayed on the login form when the user must reset their password. String SecurityHeaderOptions Enable this option to add the Strict-Transport-Security header to all LoadMaster-generated messages (ESP and error messages). 0 - Don't add the Strict Transport Security Header (default value) 1 - Add the Strict Transport Security Header - no subdomains 2 - Add the Strict Transport Security Header - include subdomains Enable this option to add the Strict-Transport-Security header to all LoadMaster-generated messages (ESP and error messages). Int16 InputAuthMode Specifies the client authentication method to be used: 0 - Delegate to Server 1 - Basic Authentication 2 - Form Based 4 - Client Certificate 5 - NTLM 6 - SAML Int16 OutConf String OutputAuthMode Specifies the server authentication mode to be used: 0 - None 1 - Basic Authentication 2 - Form Based 3 - KCD Int16 StartTLSMode 0 - HTTP/HTTPS (the Service Type needs to be set to HTTP/HTTPS for this to work) The Virtual Service Type must be set to STARTTLS for the remaining values to be set: 1 - SMTP (STARTTLS if requested) 2 - SMTP (STARTTLS always) 3 - FTP 4 - IMAP 6 - POP3 Int16 ExtraPorts Specifies extra ports that the Virtual Service will listen to. String AltAddress Specifies the alternate address for this Virtual Service. String MultiConnect Enabling this option permits the LoadMaster to manage connection handling between the LoadMaster and the Real Servers. Requests from multiple clients will be sent over the same TCP connection. Multiplexing only works for simple HTTP GET operations. This parameter cannot be enabled in certain situations, for example if WAF, ESP or SSL Acceleration is enabled. Boolean SingleSignOnDir This parameter relates to the SSO Image Set drop-down in the ESP Options section of the modify Virtual Service screen. Specify the name of the image set to be used for the login screen. If no image set is specified, the default Exchange image set will be used. String OCSPVerify Specifies whether to verify (via Online Certificate Status Protocol (OCSP)) that the client certificate is valid. String FollowVSID Specifies the ID of the Virtual Service to follow. Int32 TlsType Specify which of the following protocols to support; SSLv3, TLS1.0, TLS1.1 or TLS1.2. By default, TLS1.1 and TLS1.2 are enabled. The protocols can be enabled and disabled using a bitmask value. Refer to the table below to find out what number corresponds to which settings. Number | SSLv3 | TLS1.0 | TLS1.1 | TLS1.2 0 | Enabled | Enabled | Enabled | Enabled 1 | Disabled | Enabled | Enabled | Enabled 2 | Enabled | Disabled | Enabled | Enabled 3 | Disabled | Disabled | Enabled | Enabled 4 | Enabled | Enabled | Disabled | Enabled 5 | Disabled | Enabled | Disabled | Enabled 6 | Enabled | Disabled | Disabled | Enabled 7 | Disabled | Disabled | Disabled | Enabled 8 | Enabled | Enabled | Enabled | Disabled 9 | Disabled | Enabled | Enabled | Disabled 10 | Enabled | Disabled | Enabled | Disabled 11 | Disabled | Disabled | Enabled | Disabled 12 | Enabled | Enabled | Disabled | Disabled 13 | Disabled | Enabled | Disabled | Disabled 14 | Enabled | Disabled | Disabled | Disabled Int32 CheckPostData This parameter is only relevant if the HTTP Method is set to POST. When using the POST method, up to 2047 characters of POST data can be sent to the server. String CheckCodes A space-separated list of HTTP status codes that should be treated as successful when received from the Real Server. Range: 300-599 String PreProcPrecedence This parameter should be used in conjunction with PreProcPrecedencePos. This parameter is used to specify the name of the existing rule whose position you wish to change. This parameter relates to Content Matching Rules only. String PreProcPrecedencePos This parameter, in conjunction with the PreProcPrecedence parameter, is used to change the position of the rule in a sequence of rules. For example a position of 2 means the rule will be checked second. This parameter relates to the Content Matching Rules only. Int16 RequestPrecedence This parameter should be used in conjunction with RequestPrecedencePos. This parameter is used to specify the name of the existing request rule whose position you wish to change. This parameter relates to the following rule types: Content Matching Add Header Delete Header Replace Header Modify URL String RequestPrecedencePos This parameter, in conjunction with the RequestPrecedence parameter, is used to change the position of the rule in a sequence of rules. For example a position of 2 means the rule will be checked second. Int16 ResponsePrecedence This parameter should be used in conjunction with ResponsePrecedencePos. This parameter is used to specify the name of the existing response rule whose position you wish to change. This parameter relates to the following rule types: Content Matching Add Header Delete Header Replace Header String ResponsePrecedencePos This parameter, in conjunction with the ResponsePrecedence parameter, is used to change the position of the rule in a sequence of rules. For example, a position of 2 means the rule will be checked second. Int16 RsRulePrecedence This parameter should be used in conjunction with RSRulePrecedencePos. This parameter is used to specify the name of the existing rule whose position you wish to change. String RsRulePrecedencePos This parameter, in conjunction with the RSRulePrecedence parameter, is used to change the position of the rule in a sequence of rules. For example, a position of 2 means the rule will be checked second. Int16 NeedHostName When this parameter is enabled, the hostname is always required to be sent in the TLS client hello message. If it is not sent, the connection is dropped. Valid values: 0 - Disabled 1 - Enabled Boolean CopyHdrFrom This is the name of the source header field to copy into the new header field before the request is sent to the Real Servers. String CopyHdrTo This parameter is used in conjunction with the CopyHdrFrom parameter. The name of the header field into which the source header is to be copied. String ServerFbaPath Only relevant when using form-based authentication as the Server Authentication Mode (OutputAuthMode). Set the authentication path for server-side Form Based Authentication (FBA). When used in Exchange environments, this does not need to be set. String ServerFbaPost Only relevant when using form-based authentication as the Server Athentication Mode (OutputAuthMode). Set the format string used to generate POST body for server side FBA. The value must be base64-encoded. When used in Exchange environments, this does not need to be set. String Intercept Enable or disable the Web Application Firewall (WAF) for this Virtual Service. Boolean AllowHTTP2 Enable HTTP2 for this Virtual Service. SSL Acceleration must be enabled before HTTP2 can be enabled. The Best Practices cipher set should be used when HTTP2 is enabled. Boolean InterceptOpts Specifies Web Application Firewall (WAF) options for this Virtual Service. The AFP InterceptOpts parameter is a special parameter – it can be used to set the value for multiple fields, rather than just one field as with most other parameters. The InterceptOpts parameter allows the specification of most of the fields in the WAF Options section of the Virtual Service modify screen in the LoadMaster WUI. To enable WAF, set the Intercept parameter to 1. The names of the specific WUI fields that the InterceptOpts parameter is related to, are listed in the table below. One or more field values can be set in one command. Multiple values can be set in the one command by separating the values with a semi-colon. The values that are related to the same WUI option are mutually exclusive. For example, you cannot set Basic Operation to both opnormal and opblock. Value Related WUI Option Default Meaning opnormal Default Operation Audit Only Set the Basic Operation to Audit Only opblock Default Operation Audit Only Set the Basic Operation to Block Mode auditnone Audit mode No Audit Set the Audit mode to No Audit. No data is logged. auditrelevant Audit mode No Audit Set the Audit mode to Audit Relevant. Logs data which is of a warning level and higher. auditall Audit mode No Audit Set the Audit mode to Audit All. Logs all data through the Virtual Service. The Audit All option is not recommended for use in normal operation. Audit All should only be used when troubleshooting a specific problem. reqdataenable Inspect HTML POST Request Content Disabled Enable the Inspect HTML POST Request Content option reqdatadisable Inspect HTML POST Request Content Disabled Disable the Inspect HTML POST Request Content option resdataenable Process Response Data Disabled Enable the Process Response Data option resdatadisable Process Response Data Disabled Disable the Process Response Data option jsondisable Disable JSON Parser Disabled Disable the JSON parser. This option is only relevant if the Inspect HTML POST Request Content option is enabled. jsonenable Disable JSON Parser Disabled Enable the JSON parser. This option is only relevant if the Inspect HTML POST Request Content option is enabled. xmldisable Disable XML Parser Disabled Disable the XML parser. This option is only relevant if the Inspect HTML POST Request Content option is enabled. xmlenable Disable XML Parser Disabled Enable the XML parser. This option is only relevant if the Inspect HTML POST Request Content option is enabled. String InterceptRules Specifies Web Application Firewall (WAF) rules for this Virtual Service. String AlertThreshold Specifies Web Application Firewall (WAF) alert threshold for this Virtual Service. Int32 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Set-AdcVirtualService VirtualService The IP address for the Virtual Service. String VSPort The port for the Virtual Service. The port parameter is used to assign a port when initially creating a Virtual Service. If modifying the port of an existing Virtual Service, specify the existing port as the Port parameter and use the VSPort parameter to assign the new port. The reason why these must be separate parameters is because you need to specify what the port of the existing Virtual Service is (because there may be another Virtual Service with the same IP address but a different port) and if you want to change the port, a second port parameter (VSPort) is needed to specify the new port value. Int32 VSProtocol The protocol of the relevant Virtual Service. String VSIndex The index number of the Virtual Service. Int32 AddVia Specifies which headers are added to the HTTP stream. Choose the number of the option to use. 0 - Legacy Operation(XXX) 1 - None 2 - X-Forwarded-For 3 - X-Forwarded-For (No Via) 4 - X-ClientSide 5 - X-ClientSide (No Via) 6 - Via Only Int16 Cache Enables or disables caching on this Virtual Service. Boolean CertFile Specifies the name of the certificate file to use that is already installed on the load balancer. Note: This will NOT upload a certificate file to the load balancer. String CheckType Specifies the protocol to use to check if the service is up. Valid options are "tcp", "icmp", "https", "http", "smtp", "nntp", "ftp", "telnet", "pop3", "imap", "rdp", "ldap" or "none". String CheckHost The address to use to check if the service is up. String CheckPattern A regular expression string that can be validate on a 200 reply to determine if the service is up. Specify an empty value to unset CheckPattern. String CheckUrl The URL to check if the service is up. The maximum character length for the CheckUrl parameter value is 126 characters. String CheckHeaders Specify up to four additional headers/fields which will be sent with each health check request. Separate the pairs with a pipe, for example; Host:xyc|UserAgent:prq. String LdapEndpoint Specify the LDAP endpoint to use for health checks (if LDAP is selected as the CheckType). If LDAP is selected as the health check protocol, the server IP address (or addresses) and ports from the LDAP endpoint configuration will be used instead of the Real Server IP address and port. String MatchLen This parameter is only relevant when the CheckType is set to "bdata". Specify the number of bytes to find the CheckPattern within. String CheckUse1_1 Specifies that the health checker use HTTP/1.1 instead of HTTP/1.0. 0 - HTTP/1.0 1 - HTTP/1.1 Int32 CheckPort The port to use to check if the service is up. Specify 0 to unset CheckPort. Int32 EnhancedHealthChecks Enables or disables Enhanced Health Check Options for the Virtual Service. Boolean RsMinimum Specifies the minimum number of Real Servers that are required to be active for the Virtual Service to be considered up. Int32 ClientCert Specify how client certificates should be used. Valid values are 0, 1, or 2. Zero indicates that client certificates are not use. One indicates that client certificates are required. Two indicates that client certificates are required and additional HEAD information is being sent. Int16 Compress Enable or disable file compression for the Virtual Service. Boolean Cookie Specifies a cookie name. This parameter is only relevant when the persistence mode is set to "cookie", "active-cookie", "cookie-src" or "active-cook-src". String CachePercent Specifies the maximum cache usage for this virtual service. Note: Setting two Virtual Services using 50% of cache will use 100% of all cache storage. This parameter accepts values from 0 to 100. Int16 DefaultGW Specifies a Virtual Service-specific default gateway to be used to send responses back to clients. If not set, the global default gateway will be used. String Enable Enables or disables the Virtual Service. Boolean ErrorCode If no Real Servers are available, the LoadMaster can terminate the connection with an HTTP error code. Specify the error code number in this parameter. String ErrorUrl When no Real Servers are available and an error response is sent back to the client, a redirect URL can also be specified. String PortFollow This parameter was depreciated as of 7.1-24. For LoadMasters with version 7.1-24 or higher, use the FollowVSID parameter to set port following. Int32 ForceL7 Enabling ForceL7 means the Virtual Service runs at Layer 7 and not Layer 4. This may be needed for various reasons, including that only Layer 7 services can be non-transparent. Boolean Idletime Specifies the length of time (in seconds) that a connection may remain idle before it is closed. The range for this parameter is 0 to 86400. There are some special values that can be set for this parameter: - 0: Ensures the default L7 connection timeout is used. The default timeout value can be modified by setting the conntimeout parameter. - 1: Discards the connection after the packet is first forwarded – a response is not expected or handled. - 2: Uses a DNS-type of operation. The connection is dropped after the reply message. Setting it to 1 or 2 enables better performance and memory usage for UDP connections and they correspond better to how UDP is used. Int32 LocalBindAddresses Specifies a space-separated list of IP addresses. This corresponds to the Alternate Source Address in the Advanced Properties section of the WUI. Allow connections scaling over 64K Connections needs to be enabled in L7 Configuration for this feature to work. String[] VSType Specifies the type of service being load balanced: gen - Generic http - HTTP/HTTPS ts - Remote Terminal tls – STARTTLS protocols log – Log Insight String Nickname Specifies the "friendly" name of the service. In addition to the usual alphanumeric characters, the following "special" characters can be used as part of the Service Name: . @ - _ However, there must be at least one alphanumeric character before the special characters. String Persist Specifies the type of persistence (stickiness) to be used for this Virtual Service. The following persistence values are supported: ssl, cookie, active-cookie, cookie-src, active-cook-src, cookie-hash, cookie-hash-src, url, query-hash, host, header, super, super-src, src, rdp, rdp-src, rdp-sb, rdp-sb-src, udpsip and none. Note: If setting the persistence mode to an option that requires a cookie (or query-hash), the cookie parameter must also be set. String PersistTimeout The length of time (in seconds) after the last connection that the LoadMaster will remember the persistence information. Timeout values are rounded down to an even number of minutes. Setting a value that is not a number of whole minutes results in the excess being ignored. Setting a value to less than 60 seconds results in a value of 0 being set, which disables persistency. Int32 QueryTag This is the query tag to be matched if the Persist type is set to query-hash. String CipherSet Specifies a cipher set name. String SSLReencrypt This parameter is only relevant if SSL Acceleration is enabled. When this option is enabled, the SSL data stream is re-encrypted before sending to the Real Server. Boolean SSLReverse Enabling this parameter means that the data from the LoadMaster to the Real Server is re-encrypted. Boolean SSLRewrite When the Real Server rejects a request with an HTTP redirect, the requesting Location URL may need to be converted to specify HTTPS instead of HTTP (and vice versa). String ReverseSNIHostname If this option is enabled, the host name is required to be sent in the TLS client hello message. If it is not sent the connection will be dropped. String Schedule Specifies the type of scheduling of new connections to Real Servers that is to be performed. The following values are supported: rr = round robin wrr = weighted round robin lc = least connection wlc = weighted least connection fixed = fixed weighting adaptive = resource based (adaptive) sh = source IP hash dl = weighted response time sdn-adaptive = resource based (SDN adaptive) String ServerInit Specifies one of the following values: 0 - Normal Protocols 1 - SMTP 2 - SSH 3 - Other Server Initiating 4 - IMAP4 5 - MySQL 6 - POP3 Int16 SSLAcceleration Specifies whether to enable SSL handling on the Virtual Service. Boolean StandByAddr Specifies the IP address of the "Sorry" server that is to be used when no other Real Servers are available. This server will not be health checked and is assumed to be always available. String StandByPort Specifies the port of the "Sorry" server. String TransactionLimit This is a legacy parameter that should no longer be used. It was used previously when the SSL proxy was limited to 6K total connections. The transaction limit was used to limit one Virtual Service to only handle so many connections out of this 6K. On newer systems, where the limit is greater than 64K - this feature is no longer required. Int32 Transparent When using Layer 7, when this is enabled - the connection arriving at the Real Server appears to come directly from the client. Alternatively, the connection can be non-transparent, which means that the connections at the Real Server appear to come from the LoadMaster. 0 - Disabled 1 - Enabled If a Virtual Service (with or without a SubVS) has SSL re-encrypt enabled, the transparency flag of the Virtual Service has no meaning (re-encryption forces transparency to be off). The transparency setting can still be modified by the API, and is honored when re-encrypt is disabled on the Virtual Service. Boolean SubnetOriginating When transparency is not enabled, the source IP address of connections to the Real Servers is that of the Virtual Service. When transparency is enabled, the source IP address will be the IP address that is initiating connection to the Virtual Service. If the Real Server is on a subnet, and the Subnet Originating Requests option is enabled, then the subnet address of the LoadMaster will be used as the source IP address. Boolean UseforSnat By default, when the LoadMaster is being used to NAT Real Servers, the source IP address used on the Internet is that of the LoadMaster. Enabling this option allows the Real Servers configured to use the Virtual Service as the source IP address instead. If the Real Servers are configured on more than one Virtual Service which has this option set, only connections to destination port 80 will use this Virtual Service as the source IP address. Boolean QoS Specifies the Quality of Service. The following values are supported: 0 - Normal-Service 1 - Minimize-Cost 2 - Maximize-Reliability 4 - Maximize-Throughput 8 - Minimize-Delay String CheckUseGet When accessing the health check URL - the system can use the HEAD, the GET or the POST method: 0 - HEAD 1 - GET 2 - POST Int32 Verify Specifies a verification bitmask. The valid values of the Verify parameter are as follows: Bit 0: set this to 1 to enable detection intrusion. Note: Bit 0 needs to be set to 1 in order to use the other two bits. Bit 1: Determines whether to reject or drop a connection. Setting it to 1 will drop the connection. Bit 2: Determines whether to give just warnings on bad requests or also on malicious (but not invalid) requests. The following table lists the valid integers and the values they set the fields to when used: Integer Detect Malicious Requests Intrusion Handling Warnings Checkbox 0 Disabled N/A N/A 1 Enabled Drop Connection Unchecked 2 Enabled Send Reject Unchecked 3 Enabled Send Reject Unchecked 4 Enabled Drop Connection Checked 5 Enabled Drop Connection Checked 6 Enabled Send Reject Checked 7 Enabled Send Reject Checked Int16 ExtraHdrKey Specifies the key for the extra header to be inserted into every request sent to the Real Servers. String ExtraHdrValue Specifies the value for the extra header to be inserted into every request sent to the Real Servers. String AllowedHosts This parameter is only relevant when ESP is enabled. Specifies all the virtual hosts that can be accessed via this Virtual Service. String AllowedDirectories This parameter is only relevant when ESP is enabled. Specifies all the virtual directories that can be accessed via this Virtual Service. String AllowedGroups Specifies the groups that are allowed to access this Virtual Service. String GroupSIDs Specify the group security identifiers (SIDs) that are allowed to access this Virtual Service. Each group must be separated by a semicolon. String SteeringGroups Enter the Active Directory group names that will be used for steering traffic. Use a semi-colon to separate multiple group names. The steering group index number corresponds to the location of the group in this list. String IncludeNestedGroups Specify if nested groups should be included in the authentication attempt. Boolean DisplayPubPriv Display the public/private option on the login page. Based on the option the user selects on the login form, the session timeout value will be set to the value specified for either the public or private timeout. Boolean DisablePasswordForm Enabling this option removes the password field from the login page. This may be needed when password validation is not required, for example if using RSA SecurID authentication in a singular fashion. Boolean Domain Specifies the Single Sign On (SSO) domain in which this Virtual Service will operate. String AltDomains Specifies alternative domains to be assigned to a Virtual Service when configuring multi-domain authentication. To specify multiple alternative domains use a space-separated list. String Logoff This parameter is only relevant when ESP is enabled and when the Client Authentication Mode is set to Form Based. Specify the string that the LoadMaster should use to detect a logout event. Multiple logoff strings can be specified by using a space-separated list. If the URL to be matched contains sub-directories before the specified string, the Logoff String will not be matched. Therefore the LoadMaster will not log the user off. String ESPLogs Enable ESP logging. Valid values are below: 0 - Logging off 1 - User Access 2 - Security 3 - User Access and Security 4 - Connection 5 - User Access and Connection 6 - Security and connection 7 - User Access, Security and Connection Note: The only valid values for SMTP services are 0 and 4. For SMTP services, security issues are always logged. Nothing is logged for user access because there are no logins. Int16 SMTPAllowedDomains Specifies all the permitted domains that are allowed to be received by this Virtual Service. String ESPEnabled Specifies whether to enable or disable the Edge Security Pack (ESP) features. Boolean UserPwdChangeUrl This is relevant when using form-based LDAP authentication. Specify the URL that users can use to change their password. If a user’s password has expired, or if they must reset their password, this URL and the UserPwdChangeMsg is displayed on the login form. This URL must be put into the exception list for authentication, if required. String UserPwdChangeMsg This parameter is only relevant if the UserPwdChangeURL parameter is set. Specify the text to be displayed on the login form when the user must reset their password. String SecurityHeaderOptions Enable this option to add the Strict-Transport-Security header to all LoadMaster-generated messages (ESP and error messages). 0 - Don't add the Strict Transport Security Header (default value) 1 - Add the Strict Transport Security Header - no subdomains 2 - Add the Strict Transport Security Header - include subdomains Enable this option to add the Strict-Transport-Security header to all LoadMaster-generated messages (ESP and error messages). Int16 InputAuthMode Specifies the client authentication method to be used: 0 - Delegate to Server 1 - Basic Authentication 2 - Form Based 4 - Client Certificate 5 - NTLM 6 - SAML Int16 OutConf String OutputAuthMode Specifies the server authentication mode to be used: 0 - None 1 - Basic Authentication 2 - Form Based 3 - KCD Int16 StartTLSMode 0 - HTTP/HTTPS (the Service Type needs to be set to HTTP/HTTPS for this to work) The Virtual Service Type must be set to STARTTLS for the remaining values to be set: 1 - SMTP (STARTTLS if requested) 2 - SMTP (STARTTLS always) 3 - FTP 4 - IMAP 6 - POP3 Int16 ExtraPorts Specifies extra ports that the Virtual Service will listen to. String AltAddress Specifies the alternate address for this Virtual Service. String MultiConnect Enabling this option permits the LoadMaster to manage connection handling between the LoadMaster and the Real Servers. Requests from multiple clients will be sent over the same TCP connection. Multiplexing only works for simple HTTP GET operations. This parameter cannot be enabled in certain situations, for example if WAF, ESP or SSL Acceleration is enabled. Boolean SingleSignOnDir This parameter relates to the SSO Image Set drop-down in the ESP Options section of the modify Virtual Service screen. Specify the name of the image set to be used for the login screen. If no image set is specified, the default Exchange image set will be used. String OCSPVerify Specifies whether to verify (via Online Certificate Status Protocol (OCSP)) that the client certificate is valid. String FollowVSID Specifies the ID of the Virtual Service to follow. Int32 TlsType Specify which of the following protocols to support; SSLv3, TLS1.0, TLS1.1 or TLS1.2. By default, TLS1.1 and TLS1.2 are enabled. The protocols can be enabled and disabled using a bitmask value. Refer to the table below to find out what number corresponds to which settings. Number | SSLv3 | TLS1.0 | TLS1.1 | TLS1.2 0 | Enabled | Enabled | Enabled | Enabled 1 | Disabled | Enabled | Enabled | Enabled 2 | Enabled | Disabled | Enabled | Enabled 3 | Disabled | Disabled | Enabled | Enabled 4 | Enabled | Enabled | Disabled | Enabled 5 | Disabled | Enabled | Disabled | Enabled 6 | Enabled | Disabled | Disabled | Enabled 7 | Disabled | Disabled | Disabled | Enabled 8 | Enabled | Enabled | Enabled | Disabled 9 | Disabled | Enabled | Enabled | Disabled 10 | Enabled | Disabled | Enabled | Disabled 11 | Disabled | Disabled | Enabled | Disabled 12 | Enabled | Enabled | Disabled | Disabled 13 | Disabled | Enabled | Disabled | Disabled 14 | Enabled | Disabled | Disabled | Disabled Int32 CheckPostData This parameter is only relevant if the HTTP Method is set to POST. When using the POST method, up to 2047 characters of POST data can be sent to the server. String CheckCodes A space-separated list of HTTP status codes that should be treated as successful when received from the Real Server. Range: 300-599 String PreProcPrecedence This parameter should be used in conjunction with PreProcPrecedencePos. This parameter is used to specify the name of the existing rule whose position you wish to change. This parameter relates to Content Matching Rules only. String PreProcPrecedencePos This parameter, in conjunction with the PreProcPrecedence parameter, is used to change the position of the rule in a sequence of rules. For example a position of 2 means the rule will be checked second. This parameter relates to the Content Matching Rules only. Int16 RequestPrecedence This parameter should be used in conjunction with RequestPrecedencePos. This parameter is used to specify the name of the existing request rule whose position you wish to change. This parameter relates to the following rule types: Content Matching Add Header Delete Header Replace Header Modify URL String RequestPrecedencePos This parameter, in conjunction with the RequestPrecedence parameter, is used to change the position of the rule in a sequence of rules. For example a position of 2 means the rule will be checked second. Int16 ResponsePrecedence This parameter should be used in conjunction with ResponsePrecedencePos. This parameter is used to specify the name of the existing response rule whose position you wish to change. This parameter relates to the following rule types: Content Matching Add Header Delete Header Replace Header String ResponsePrecedencePos This parameter, in conjunction with the ResponsePrecedence parameter, is used to change the position of the rule in a sequence of rules. For example, a position of 2 means the rule will be checked second. Int16 RsRulePrecedence This parameter should be used in conjunction with RSRulePrecedencePos. This parameter is used to specify the name of the existing rule whose position you wish to change. String RsRulePrecedencePos This parameter, in conjunction with the RSRulePrecedence parameter, is used to change the position of the rule in a sequence of rules. For example, a position of 2 means the rule will be checked second. Int16 NeedHostName When this parameter is enabled, the hostname is always required to be sent in the TLS client hello message. If it is not sent, the connection is dropped. Valid values: 0 - Disabled 1 - Enabled Boolean CopyHdrFrom This is the name of the source header field to copy into the new header field before the request is sent to the Real Servers. String CopyHdrTo This parameter is used in conjunction with the CopyHdrFrom parameter. The name of the header field into which the source header is to be copied. String ServerFbaPath Only relevant when using form-based authentication as the Server Authentication Mode (OutputAuthMode). Set the authentication path for server-side Form Based Authentication (FBA). When used in Exchange environments, this does not need to be set. String ServerFbaPost Only relevant when using form-based authentication as the Server Athentication Mode (OutputAuthMode). Set the format string used to generate POST body for server side FBA. The value must be base64-encoded. When used in Exchange environments, this does not need to be set. String Intercept Enable or disable the Web Application Firewall (WAF) for this Virtual Service. Boolean AllowHTTP2 Enable HTTP2 for this Virtual Service. SSL Acceleration must be enabled before HTTP2 can be enabled. The Best Practices cipher set should be used when HTTP2 is enabled. Boolean InterceptOpts Specifies Web Application Firewall (WAF) options for this Virtual Service. The AFP InterceptOpts parameter is a special parameter – it can be used to set the value for multiple fields, rather than just one field as with most other parameters. The InterceptOpts parameter allows the specification of most of the fields in the WAF Options section of the Virtual Service modify screen in the LoadMaster WUI. To enable WAF, set the Intercept parameter to 1. The names of the specific WUI fields that the InterceptOpts parameter is related to, are listed in the table below. One or more field values can be set in one command. Multiple values can be set in the one command by separating the values with a semi-colon. The values that are related to the same WUI option are mutually exclusive. For example, you cannot set Basic Operation to both opnormal and opblock. Value Related WUI Option Default Meaning opnormal Default Operation Audit Only Set the Basic Operation to Audit Only opblock Default Operation Audit Only Set the Basic Operation to Block Mode auditnone Audit mode No Audit Set the Audit mode to No Audit. No data is logged. auditrelevant Audit mode No Audit Set the Audit mode to Audit Relevant. Logs data which is of a warning level and higher. auditall Audit mode No Audit Set the Audit mode to Audit All. Logs all data through the Virtual Service. The Audit All option is not recommended for use in normal operation. Audit All should only be used when troubleshooting a specific problem. reqdataenable Inspect HTML POST Request Content Disabled Enable the Inspect HTML POST Request Content option reqdatadisable Inspect HTML POST Request Content Disabled Disable the Inspect HTML POST Request Content option resdataenable Process Response Data Disabled Enable the Process Response Data option resdatadisable Process Response Data Disabled Disable the Process Response Data option jsondisable Disable JSON Parser Disabled Disable the JSON parser. This option is only relevant if the Inspect HTML POST Request Content option is enabled. jsonenable Disable JSON Parser Disabled Enable the JSON parser. This option is only relevant if the Inspect HTML POST Request Content option is enabled. xmldisable Disable XML Parser Disabled Disable the XML parser. This option is only relevant if the Inspect HTML POST Request Content option is enabled. xmlenable Disable XML Parser Disabled Enable the XML parser. This option is only relevant if the Inspect HTML POST Request Content option is enabled. String InterceptRules Specifies Web Application Firewall (WAF) rules for this Virtual Service. String AlertThreshold Specifies Web Application Firewall (WAF) alert threshold for this Virtual Service. Int32 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String VirtualService The IP address for the Virtual Service. String String VSPort The port for the Virtual Service. The port parameter is used to assign a port when initially creating a Virtual Service. If modifying the port of an existing Virtual Service, specify the existing port as the Port parameter and use the VSPort parameter to assign the new port. The reason why these must be separate parameters is because you need to specify what the port of the existing Virtual Service is (because there may be another Virtual Service with the same IP address but a different port) and if you want to change the port, a second port parameter (VSPort) is needed to specify the new port value. Int32 Int32 VSProtocol The protocol of the relevant Virtual Service. String String VSIndex The index number of the Virtual Service. Int32 Int32 AddVia Specifies which headers are added to the HTTP stream. Choose the number of the option to use. 0 - Legacy Operation(XXX) 1 - None 2 - X-Forwarded-For 3 - X-Forwarded-For (No Via) 4 - X-ClientSide 5 - X-ClientSide (No Via) 6 - Via Only Int16 Int16 Cache Enables or disables caching on this Virtual Service. Boolean Boolean CertFile Specifies the name of the certificate file to use that is already installed on the load balancer. Note: This will NOT upload a certificate file to the load balancer. String String CheckType Specifies the protocol to use to check if the service is up. Valid options are "tcp", "icmp", "https", "http", "smtp", "nntp", "ftp", "telnet", "pop3", "imap", "rdp", "ldap" or "none". String String CheckHost The address to use to check if the service is up. String String CheckPattern A regular expression string that can be validate on a 200 reply to determine if the service is up. Specify an empty value to unset CheckPattern. String String CheckUrl The URL to check if the service is up. The maximum character length for the CheckUrl parameter value is 126 characters. String String CheckHeaders Specify up to four additional headers/fields which will be sent with each health check request. Separate the pairs with a pipe, for example; Host:xyc|UserAgent:prq. String String LdapEndpoint Specify the LDAP endpoint to use for health checks (if LDAP is selected as the CheckType). If LDAP is selected as the health check protocol, the server IP address (or addresses) and ports from the LDAP endpoint configuration will be used instead of the Real Server IP address and port. String String MatchLen This parameter is only relevant when the CheckType is set to "bdata". Specify the number of bytes to find the CheckPattern within. String String CheckUse1_1 Specifies that the health checker use HTTP/1.1 instead of HTTP/1.0. 0 - HTTP/1.0 1 - HTTP/1.1 Int32 Int32 CheckPort The port to use to check if the service is up. Specify 0 to unset CheckPort. Int32 Int32 EnhancedHealthChecks Enables or disables Enhanced Health Check Options for the Virtual Service. Boolean Boolean RsMinimum Specifies the minimum number of Real Servers that are required to be active for the Virtual Service to be considered up. Int32 Int32 ClientCert Specify how client certificates should be used. Valid values are 0, 1, or 2. Zero indicates that client certificates are not use. One indicates that client certificates are required. Two indicates that client certificates are required and additional HEAD information is being sent. Int16 Int16 Compress Enable or disable file compression for the Virtual Service. Boolean Boolean Cookie Specifies a cookie name. This parameter is only relevant when the persistence mode is set to "cookie", "active-cookie", "cookie-src" or "active-cook-src". String String CachePercent Specifies the maximum cache usage for this virtual service. Note: Setting two Virtual Services using 50% of cache will use 100% of all cache storage. This parameter accepts values from 0 to 100. Int16 Int16 DefaultGW Specifies a Virtual Service-specific default gateway to be used to send responses back to clients. If not set, the global default gateway will be used. String String Enable Enables or disables the Virtual Service. Boolean Boolean ErrorCode If no Real Servers are available, the LoadMaster can terminate the connection with an HTTP error code. Specify the error code number in this parameter. String String ErrorUrl When no Real Servers are available and an error response is sent back to the client, a redirect URL can also be specified. String String PortFollow This parameter was depreciated as of 7.1-24. For LoadMasters with version 7.1-24 or higher, use the FollowVSID parameter to set port following. Int32 Int32 ForceL7 Enabling ForceL7 means the Virtual Service runs at Layer 7 and not Layer 4. This may be needed for various reasons, including that only Layer 7 services can be non-transparent. Boolean Boolean Idletime Specifies the length of time (in seconds) that a connection may remain idle before it is closed. The range for this parameter is 0 to 86400. There are some special values that can be set for this parameter: - 0: Ensures the default L7 connection timeout is used. The default timeout value can be modified by setting the conntimeout parameter. - 1: Discards the connection after the packet is first forwarded – a response is not expected or handled. - 2: Uses a DNS-type of operation. The connection is dropped after the reply message. Setting it to 1 or 2 enables better performance and memory usage for UDP connections and they correspond better to how UDP is used. Int32 Int32 LocalBindAddresses Specifies a space-separated list of IP addresses. This corresponds to the Alternate Source Address in the Advanced Properties section of the WUI. Allow connections scaling over 64K Connections needs to be enabled in L7 Configuration for this feature to work. String[] String[] VSType Specifies the type of service being load balanced: gen - Generic http - HTTP/HTTPS ts - Remote Terminal tls – STARTTLS protocols log – Log Insight String String Nickname Specifies the "friendly" name of the service. In addition to the usual alphanumeric characters, the following "special" characters can be used as part of the Service Name: . @ - _ However, there must be at least one alphanumeric character before the special characters. String String Persist Specifies the type of persistence (stickiness) to be used for this Virtual Service. The following persistence values are supported: ssl, cookie, active-cookie, cookie-src, active-cook-src, cookie-hash, cookie-hash-src, url, query-hash, host, header, super, super-src, src, rdp, rdp-src, rdp-sb, rdp-sb-src, udpsip and none. Note: If setting the persistence mode to an option that requires a cookie (or query-hash), the cookie parameter must also be set. String String PersistTimeout The length of time (in seconds) after the last connection that the LoadMaster will remember the persistence information. Timeout values are rounded down to an even number of minutes. Setting a value that is not a number of whole minutes results in the excess being ignored. Setting a value to less than 60 seconds results in a value of 0 being set, which disables persistency. Int32 Int32 QueryTag This is the query tag to be matched if the Persist type is set to query-hash. String String CipherSet Specifies a cipher set name. String String SSLReencrypt This parameter is only relevant if SSL Acceleration is enabled. When this option is enabled, the SSL data stream is re-encrypted before sending to the Real Server. Boolean Boolean SSLReverse Enabling this parameter means that the data from the LoadMaster to the Real Server is re-encrypted. Boolean Boolean SSLRewrite When the Real Server rejects a request with an HTTP redirect, the requesting Location URL may need to be converted to specify HTTPS instead of HTTP (and vice versa). String String ReverseSNIHostname If this option is enabled, the host name is required to be sent in the TLS client hello message. If it is not sent the connection will be dropped. String String Schedule Specifies the type of scheduling of new connections to Real Servers that is to be performed. The following values are supported: rr = round robin wrr = weighted round robin lc = least connection wlc = weighted least connection fixed = fixed weighting adaptive = resource based (adaptive) sh = source IP hash dl = weighted response time sdn-adaptive = resource based (SDN adaptive) String String ServerInit Specifies one of the following values: 0 - Normal Protocols 1 - SMTP 2 - SSH 3 - Other Server Initiating 4 - IMAP4 5 - MySQL 6 - POP3 Int16 Int16 SSLAcceleration Specifies whether to enable SSL handling on the Virtual Service. Boolean Boolean StandByAddr Specifies the IP address of the "Sorry" server that is to be used when no other Real Servers are available. This server will not be health checked and is assumed to be always available. String String StandByPort Specifies the port of the "Sorry" server. String String TransactionLimit This is a legacy parameter that should no longer be used. It was used previously when the SSL proxy was limited to 6K total connections. The transaction limit was used to limit one Virtual Service to only handle so many connections out of this 6K. On newer systems, where the limit is greater than 64K - this feature is no longer required. Int32 Int32 Transparent When using Layer 7, when this is enabled - the connection arriving at the Real Server appears to come directly from the client. Alternatively, the connection can be non-transparent, which means that the connections at the Real Server appear to come from the LoadMaster. 0 - Disabled 1 - Enabled If a Virtual Service (with or without a SubVS) has SSL re-encrypt enabled, the transparency flag of the Virtual Service has no meaning (re-encryption forces transparency to be off). The transparency setting can still be modified by the API, and is honored when re-encrypt is disabled on the Virtual Service. Boolean Boolean SubnetOriginating When transparency is not enabled, the source IP address of connections to the Real Servers is that of the Virtual Service. When transparency is enabled, the source IP address will be the IP address that is initiating connection to the Virtual Service. If the Real Server is on a subnet, and the Subnet Originating Requests option is enabled, then the subnet address of the LoadMaster will be used as the source IP address. Boolean Boolean UseforSnat By default, when the LoadMaster is being used to NAT Real Servers, the source IP address used on the Internet is that of the LoadMaster. Enabling this option allows the Real Servers configured to use the Virtual Service as the source IP address instead. If the Real Servers are configured on more than one Virtual Service which has this option set, only connections to destination port 80 will use this Virtual Service as the source IP address. Boolean Boolean QoS Specifies the Quality of Service. The following values are supported: 0 - Normal-Service 1 - Minimize-Cost 2 - Maximize-Reliability 4 - Maximize-Throughput 8 - Minimize-Delay String String CheckUseGet When accessing the health check URL - the system can use the HEAD, the GET or the POST method: 0 - HEAD 1 - GET 2 - POST Int32 Int32 Verify Specifies a verification bitmask. The valid values of the Verify parameter are as follows: Bit 0: set this to 1 to enable detection intrusion. Note: Bit 0 needs to be set to 1 in order to use the other two bits. Bit 1: Determines whether to reject or drop a connection. Setting it to 1 will drop the connection. Bit 2: Determines whether to give just warnings on bad requests or also on malicious (but not invalid) requests. The following table lists the valid integers and the values they set the fields to when used: Integer Detect Malicious Requests Intrusion Handling Warnings Checkbox 0 Disabled N/A N/A 1 Enabled Drop Connection Unchecked 2 Enabled Send Reject Unchecked 3 Enabled Send Reject Unchecked 4 Enabled Drop Connection Checked 5 Enabled Drop Connection Checked 6 Enabled Send Reject Checked 7 Enabled Send Reject Checked Int16 Int16 ExtraHdrKey Specifies the key for the extra header to be inserted into every request sent to the Real Servers. String String ExtraHdrValue Specifies the value for the extra header to be inserted into every request sent to the Real Servers. String String AllowedHosts This parameter is only relevant when ESP is enabled. Specifies all the virtual hosts that can be accessed via this Virtual Service. String String AllowedDirectories This parameter is only relevant when ESP is enabled. Specifies all the virtual directories that can be accessed via this Virtual Service. String String AllowedGroups Specifies the groups that are allowed to access this Virtual Service. String String GroupSIDs Specify the group security identifiers (SIDs) that are allowed to access this Virtual Service. Each group must be separated by a semicolon. String String SteeringGroups Enter the Active Directory group names that will be used for steering traffic. Use a semi-colon to separate multiple group names. The steering group index number corresponds to the location of the group in this list. String String IncludeNestedGroups Specify if nested groups should be included in the authentication attempt. Boolean Boolean DisplayPubPriv Display the public/private option on the login page. Based on the option the user selects on the login form, the session timeout value will be set to the value specified for either the public or private timeout. Boolean Boolean DisablePasswordForm Enabling this option removes the password field from the login page. This may be needed when password validation is not required, for example if using RSA SecurID authentication in a singular fashion. Boolean Boolean Domain Specifies the Single Sign On (SSO) domain in which this Virtual Service will operate. String String AltDomains Specifies alternative domains to be assigned to a Virtual Service when configuring multi-domain authentication. To specify multiple alternative domains use a space-separated list. String String Logoff This parameter is only relevant when ESP is enabled and when the Client Authentication Mode is set to Form Based. Specify the string that the LoadMaster should use to detect a logout event. Multiple logoff strings can be specified by using a space-separated list. If the URL to be matched contains sub-directories before the specified string, the Logoff String will not be matched. Therefore the LoadMaster will not log the user off. String String ESPLogs Enable ESP logging. Valid values are below: 0 - Logging off 1 - User Access 2 - Security 3 - User Access and Security 4 - Connection 5 - User Access and Connection 6 - Security and connection 7 - User Access, Security and Connection Note: The only valid values for SMTP services are 0 and 4. For SMTP services, security issues are always logged. Nothing is logged for user access because there are no logins. Int16 Int16 SMTPAllowedDomains Specifies all the permitted domains that are allowed to be received by this Virtual Service. String String ESPEnabled Specifies whether to enable or disable the Edge Security Pack (ESP) features. Boolean Boolean UserPwdChangeUrl This is relevant when using form-based LDAP authentication. Specify the URL that users can use to change their password. If a user’s password has expired, or if they must reset their password, this URL and the UserPwdChangeMsg is displayed on the login form. This URL must be put into the exception list for authentication, if required. String String UserPwdChangeMsg This parameter is only relevant if the UserPwdChangeURL parameter is set. Specify the text to be displayed on the login form when the user must reset their password. String String SecurityHeaderOptions Enable this option to add the Strict-Transport-Security header to all LoadMaster-generated messages (ESP and error messages). 0 - Don't add the Strict Transport Security Header (default value) 1 - Add the Strict Transport Security Header - no subdomains 2 - Add the Strict Transport Security Header - include subdomains Enable this option to add the Strict-Transport-Security header to all LoadMaster-generated messages (ESP and error messages). Int16 Int16 InputAuthMode Specifies the client authentication method to be used: 0 - Delegate to Server 1 - Basic Authentication 2 - Form Based 4 - Client Certificate 5 - NTLM 6 - SAML Int16 Int16 OutConf String String OutputAuthMode Specifies the server authentication mode to be used: 0 - None 1 - Basic Authentication 2 - Form Based 3 - KCD Int16 Int16 StartTLSMode 0 - HTTP/HTTPS (the Service Type needs to be set to HTTP/HTTPS for this to work) The Virtual Service Type must be set to STARTTLS for the remaining values to be set: 1 - SMTP (STARTTLS if requested) 2 - SMTP (STARTTLS always) 3 - FTP 4 - IMAP 6 - POP3 Int16 Int16 ExtraPorts Specifies extra ports that the Virtual Service will listen to. String String AltAddress Specifies the alternate address for this Virtual Service. String String MultiConnect Enabling this option permits the LoadMaster to manage connection handling between the LoadMaster and the Real Servers. Requests from multiple clients will be sent over the same TCP connection. Multiplexing only works for simple HTTP GET operations. This parameter cannot be enabled in certain situations, for example if WAF, ESP or SSL Acceleration is enabled. Boolean Boolean SingleSignOnDir This parameter relates to the SSO Image Set drop-down in the ESP Options section of the modify Virtual Service screen. Specify the name of the image set to be used for the login screen. If no image set is specified, the default Exchange image set will be used. String String OCSPVerify Specifies whether to verify (via Online Certificate Status Protocol (OCSP)) that the client certificate is valid. String String FollowVSID Specifies the ID of the Virtual Service to follow. Int32 Int32 TlsType Specify which of the following protocols to support; SSLv3, TLS1.0, TLS1.1 or TLS1.2. By default, TLS1.1 and TLS1.2 are enabled. The protocols can be enabled and disabled using a bitmask value. Refer to the table below to find out what number corresponds to which settings. Number | SSLv3 | TLS1.0 | TLS1.1 | TLS1.2 0 | Enabled | Enabled | Enabled | Enabled 1 | Disabled | Enabled | Enabled | Enabled 2 | Enabled | Disabled | Enabled | Enabled 3 | Disabled | Disabled | Enabled | Enabled 4 | Enabled | Enabled | Disabled | Enabled 5 | Disabled | Enabled | Disabled | Enabled 6 | Enabled | Disabled | Disabled | Enabled 7 | Disabled | Disabled | Disabled | Enabled 8 | Enabled | Enabled | Enabled | Disabled 9 | Disabled | Enabled | Enabled | Disabled 10 | Enabled | Disabled | Enabled | Disabled 11 | Disabled | Disabled | Enabled | Disabled 12 | Enabled | Enabled | Disabled | Disabled 13 | Disabled | Enabled | Disabled | Disabled 14 | Enabled | Disabled | Disabled | Disabled Int32 Int32 CheckPostData This parameter is only relevant if the HTTP Method is set to POST. When using the POST method, up to 2047 characters of POST data can be sent to the server. String String CheckCodes A space-separated list of HTTP status codes that should be treated as successful when received from the Real Server. Range: 300-599 String String PreProcPrecedence This parameter should be used in conjunction with PreProcPrecedencePos. This parameter is used to specify the name of the existing rule whose position you wish to change. This parameter relates to Content Matching Rules only. String String PreProcPrecedencePos This parameter, in conjunction with the PreProcPrecedence parameter, is used to change the position of the rule in a sequence of rules. For example a position of 2 means the rule will be checked second. This parameter relates to the Content Matching Rules only. Int16 Int16 RequestPrecedence This parameter should be used in conjunction with RequestPrecedencePos. This parameter is used to specify the name of the existing request rule whose position you wish to change. This parameter relates to the following rule types: Content Matching Add Header Delete Header Replace Header Modify URL String String RequestPrecedencePos This parameter, in conjunction with the RequestPrecedence parameter, is used to change the position of the rule in a sequence of rules. For example a position of 2 means the rule will be checked second. Int16 Int16 ResponsePrecedence This parameter should be used in conjunction with ResponsePrecedencePos. This parameter is used to specify the name of the existing response rule whose position you wish to change. This parameter relates to the following rule types: Content Matching Add Header Delete Header Replace Header String String ResponsePrecedencePos This parameter, in conjunction with the ResponsePrecedence parameter, is used to change the position of the rule in a sequence of rules. For example, a position of 2 means the rule will be checked second. Int16 Int16 RsRulePrecedence This parameter should be used in conjunction with RSRulePrecedencePos. This parameter is used to specify the name of the existing rule whose position you wish to change. String String RsRulePrecedencePos This parameter, in conjunction with the RSRulePrecedence parameter, is used to change the position of the rule in a sequence of rules. For example, a position of 2 means the rule will be checked second. Int16 Int16 NeedHostName When this parameter is enabled, the hostname is always required to be sent in the TLS client hello message. If it is not sent, the connection is dropped. Valid values: 0 - Disabled 1 - Enabled Boolean Boolean CopyHdrFrom This is the name of the source header field to copy into the new header field before the request is sent to the Real Servers. String String CopyHdrTo This parameter is used in conjunction with the CopyHdrFrom parameter. The name of the header field into which the source header is to be copied. String String ServerFbaPath Only relevant when using form-based authentication as the Server Authentication Mode (OutputAuthMode). Set the authentication path for server-side Form Based Authentication (FBA). When used in Exchange environments, this does not need to be set. String String ServerFbaPost Only relevant when using form-based authentication as the Server Athentication Mode (OutputAuthMode). Set the format string used to generate POST body for server side FBA. The value must be base64-encoded. When used in Exchange environments, this does not need to be set. String String Intercept Enable or disable the Web Application Firewall (WAF) for this Virtual Service. Boolean Boolean AllowHTTP2 Enable HTTP2 for this Virtual Service. SSL Acceleration must be enabled before HTTP2 can be enabled. The Best Practices cipher set should be used when HTTP2 is enabled. Boolean Boolean InterceptOpts Specifies Web Application Firewall (WAF) options for this Virtual Service. The AFP InterceptOpts parameter is a special parameter – it can be used to set the value for multiple fields, rather than just one field as with most other parameters. The InterceptOpts parameter allows the specification of most of the fields in the WAF Options section of the Virtual Service modify screen in the LoadMaster WUI. To enable WAF, set the Intercept parameter to 1. The names of the specific WUI fields that the InterceptOpts parameter is related to, are listed in the table below. One or more field values can be set in one command. Multiple values can be set in the one command by separating the values with a semi-colon. The values that are related to the same WUI option are mutually exclusive. For example, you cannot set Basic Operation to both opnormal and opblock. Value Related WUI Option Default Meaning opnormal Default Operation Audit Only Set the Basic Operation to Audit Only opblock Default Operation Audit Only Set the Basic Operation to Block Mode auditnone Audit mode No Audit Set the Audit mode to No Audit. No data is logged. auditrelevant Audit mode No Audit Set the Audit mode to Audit Relevant. Logs data which is of a warning level and higher. auditall Audit mode No Audit Set the Audit mode to Audit All. Logs all data through the Virtual Service. The Audit All option is not recommended for use in normal operation. Audit All should only be used when troubleshooting a specific problem. reqdataenable Inspect HTML POST Request Content Disabled Enable the Inspect HTML POST Request Content option reqdatadisable Inspect HTML POST Request Content Disabled Disable the Inspect HTML POST Request Content option resdataenable Process Response Data Disabled Enable the Process Response Data option resdatadisable Process Response Data Disabled Disable the Process Response Data option jsondisable Disable JSON Parser Disabled Disable the JSON parser. This option is only relevant if the Inspect HTML POST Request Content option is enabled. jsonenable Disable JSON Parser Disabled Enable the JSON parser. This option is only relevant if the Inspect HTML POST Request Content option is enabled. xmldisable Disable XML Parser Disabled Disable the XML parser. This option is only relevant if the Inspect HTML POST Request Content option is enabled. xmlenable Disable XML Parser Disabled Enable the XML parser. This option is only relevant if the Inspect HTML POST Request Content option is enabled. String String InterceptRules Specifies Web Application Firewall (WAF) rules for this Virtual Service. String String AlertThreshold Specifies Web Application Firewall (WAF) alert threshold for this Virtual Service. Int32 Int32 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String Port The port for the Virtual Service. A wildcard port can also be specified by using an asterisk (*). The Port parameter is used to assign a port when initially creating a Virtual Service. If modifying the port of an existing Virtual Service, specify the existing port as the Port parameter and use the VSPort parameter to assign the new port. The reason why these must be separate parameters is because you need to specify what the port of the existing Virtual Service is (because there may be another Virtual Service with the same IP address but a different port) and if you want to change the port, a second port parameter (VSPort) is needed to specify the new port value. int32 int32 Protocol Specify if the service is using TCP or UDP protocols. string string DisplayPasswordForm Enabling this option removes the password field from the login page. This may be needed when password validation is not required, for example if using RSA SecurID authentication in a singular fashion. boolean boolean -------------------------- Example -------------------------- PS C:\> Set-AdcVirtualService -Port 80 -Protocol tcp -VirtualService 10.154.11.90 -persist header Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Data field...: @{VS=} Param........: @{Status=Down; Index=4; VSAddress=10.154.11.90; VSPort=80; Layer=7; Enable=Y; SSLReverse=N; SSLReencrypt=N; Intercept=N; InterceptOpts=; AlertThreshold=0; Transactionlimit=0; Transparent=N; SubnetOriginating=Y; ServerInit=0; StartTLSMode=0; Idletime=660; Cache=N; Compress=N; Verify=0; Use forSnat=N; ForceL4=N; ForceL7=Y; MultiConnect=N; ClientCert=0; ErrorCode=0; CheckUse1.1=N; MatchLen=0; CheckUseGet=0; SSLRewrite=0; VStype=http; FollowV SID=0; Protocol=tcp; Schedule=rr; CheckType=http; Persist=header; PersistTimeout=360; CheckPort=0; NRules=0; NRequestRules=0; NResponseRules=0; NPreProc essRules=0; EspEnabled=N; InputAuthMode=0; OutputAuthMode=0; MasterVS=0; MasterVSID=0; IsTransparent=2; AddVia=0; QoS=0; TlsType=0; NeedHostName=N; OCSP Verify=N; AllowHTTP2=N; EnhancedHealthChecks=N; RsMinimum=0; NumberOfRSs=0} Status : Down Index : 4 VSAddress : 10.154.11.90 VSPort : 80 Layer : 7 Enable : Y SSLReverse : N SSLReencrypt : N Intercept : N InterceptOpts : @{Opt=System.Object[]} AlertThreshold : 0 Transactionlimit : 0 Transparent : N SubnetOriginating : Y ServerInit : 0 StartTLSMode : 0 Idletime : 660 Cache : N Compress : N Verify : 0 UseforSnat : N ForceL4 : N ForceL7 : Y MultiConnect : N ClientCert : 0 ErrorCode : 0 CheckUse1.1 : N MatchLen : 0 CheckUseGet : 0 SSLRewrite : 0 VStype : http FollowVSID : 0 Protocol : tcp Schedule : rr CheckType : http Persist : header PersistTimeout : 360 CheckPort : 0 NRules : 0 NRequestRules : 0 NResponseRules : 0 NPreProcessRules : 0 EspEnabled : N InputAuthMode : 0 OutputAuthMode : 0 MasterVS : 0 MasterVSID : 0 IsTransparent : 2 AddVia : 0 QoS : 0 TlsType : 0 NeedHostName : N OCSPVerify : N AllowHTTP2 : N EnhancedHealthChecks : N RsMinimum : 0 NumberOfRSs : 0 Set-AdminAccess WARNING: This function is deprecated. Use the following command instead: Set-SecAdminAccess Set AdminAccess WARNING: This function is deprecated. Use the following command instead: Set-SecAdminAccess Set-AdminAccess WuiNetworkInterfaceId Int32 WuiPort Int32 WuiDefaultGateway String LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String Set-AdminAccess WuiNetworkInterfaceId Int32 WuiPort Int32 WuiDefaultGateway String LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String WuiNetworkInterfaceId Int32 Int32 WuiPort Int32 Int32 WuiDefaultGateway String String LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String Set-AFEConfiguration WARNING: This function is deprecated. Use the following command instead: Set-LmAFEConfiguration Set AFEConfiguration WARNING: This function is deprecated. Use the following command instead: Set-LmAFEConfiguration Set-AFEConfiguration CacheSize Int32 HostCache Boolean DetectionLevel String LimitInput Int64 LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String Set-AFEConfiguration CacheSize Int32 HostCache Boolean DetectionLevel String LimitInput Int64 LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String CacheSize Int32 Int32 HostCache Boolean Boolean DetectionLevel String String LimitInput Int64 Int64 LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String Set-AwsHAMode WARNING: This function is deprecated. Use the following command instead: Set-LmAwsHAMode Set AwsHAMode WARNING: This function is deprecated. Use the following command instead: Set-LmAwsHAMode Set-AwsHAMode HAMode String LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String Set-AwsHAMode HAMode String LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String HAMode String String LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String Set-AwsHAOption WARNING: This function is deprecated. Use the following command instead: Get-LmAwsHAConfiguration Set AwsHAOption WARNING: This function is deprecated. Use the following command instead: Get-LmAwsHAConfiguration Set-AwsHAOption Partner String HealthCheckPort String haprefered Int32 LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String Set-AwsHAOption Partner String HealthCheckPort String haprefered Int32 LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String Partner String String HealthCheckPort String String haprefered Int32 Int32 LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String Set-AzureHAMode WARNING: This function is deprecated. Use the following command instead: Set-LmAzureHAMode Set AzureHAMode WARNING: This function is deprecated. Use the following command instead: Set-LmAzureHAMode Set-AzureHAMode HAMode String LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String Set-AzureHAMode HAMode String LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String HAMode String String LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String Set-AzureHAOption WARNING: This function is deprecated. Use the following command instead: Set-AzureHAOption Set AzureHAOption WARNING: This function is deprecated. Use the following command instead: Set-AzureHAOption Set-AzureHAOption Partner String Hcp String haprefered Int32 LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String Set-AzureHAOption Partner String Hcp String haprefered Int32 LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String Partner String String Hcp String String haprefered Int32 Int32 LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String Set-BackupOption WARNING: This function is deprecated. Use the following command instead: Set-LmBackupConfiguration Set BackupOption WARNING: This function is deprecated. Use the following command instead: Set-LmBackupConfiguration Set-BackupOption BackupEnable String BackupHour Int16 BackupMinute Int16 BackupDay Int16 BackupMethod String BackupUser String BackupPassword String BackupHost String BackupPath String LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String Set-BackupOption BackupEnable String BackupHour Int16 BackupMinute Int16 BackupDay Int16 BackupMethod String BackupUser String BackupPassword String BackupHost String BackupPath String LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String BackupEnable String String BackupHour Int16 Int16 BackupMinute Int16 Int16 BackupDay Int16 Int16 BackupMethod String String BackupUser String String BackupPassword String String BackupHost String String BackupPath String String LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String Set-DateTimeOption WARNING: This function is deprecated. Use the following command instead: Set-LmDateTimeConfiguration Set DateTimeOption WARNING: This function is deprecated. Use the following command instead: Set-LmDateTimeConfiguration Set-DateTimeOption NTPHost String TimeZone String NTPKeyId Int32 NTPKeySecret String NTPKeyType String LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String Set-DateTimeOption NTPHost String TimeZone String NTPKeyId Int32 NTPKeySecret String NTPKeyType String LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String NTPHost String String TimeZone String String NTPKeyId Int32 Int32 NTPKeySecret String String NTPKeyType String String LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String Set-DebugOption WARNING: This function is deprecated. Use the following command instead: Set-LmDebugConfiguration Set DebugOption WARNING: This function is deprecated. Use the following command instead: Set-LmDebugConfiguration Set-DebugOption transparent Boolean irqbalance Boolean linearesplogs Boolean netconsole String netconsoleinterface Int16 LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String Set-DebugOption transparent Boolean irqbalance Boolean linearesplogs Boolean netconsole String netconsoleinterface Int16 LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String transparent Boolean Boolean irqbalance Boolean Boolean linearesplogs Boolean Boolean netconsole String String netconsoleinterface Int16 Int16 LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String Set-DNSConfiguration WARNING: This function is deprecated. Use the following command instead: Set-NetworkDNSConfiguration Set DNSConfiguration WARNING: This function is deprecated. Use the following command instead: Set-NetworkDNSConfiguration Set-DNSConfiguration Hostname String HA1Hostname String HA2Hostname String NameServer String Searchlist String LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String Set-DNSConfiguration Hostname String HA1Hostname String HA2Hostname String NameServer String Searchlist String LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String Hostname String String HA1Hostname String String HA2Hostname String String NameServer String String Searchlist String String LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String Set-EmailOption WARNING: This function is deprecated. Use the following command instead: Set-LogEmailConfiguration Set EmailOption WARNING: This function is deprecated. Use the following command instead: Set-LogEmailConfiguration Set-EmailOption EmailEnable Boolean EmailServer String EmailPort Int32 EmailUser String EmailPassword String EmailDomain String EmailSSLMode Int16 EmailEmergency String EmailCritical String EmailError String EmailWarn String EmailNotice String EmailInfo String LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String Set-EmailOption EmailEnable Boolean EmailServer String EmailPort Int32 EmailUser String EmailPassword String EmailDomain String EmailSSLMode Int16 EmailEmergency String EmailCritical String EmailError String EmailWarn String EmailNotice String EmailInfo String LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String EmailEnable Boolean Boolean EmailServer String String EmailPort Int32 Int32 EmailUser String String EmailPassword String String EmailDomain String String EmailSSLMode Int16 Int16 EmailEmergency String String EmailCritical String String EmailError String String EmailWarn String String EmailNotice String String EmailInfo String String LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String Set-GeoCluster Used to change the settings of a cluster. Set GeoCluster Used to change the settings of a cluster. Set-GeoCluster ClusterIp The IP address of the cluster. String ClusterName Specifies a user account that has permission to administer the load balancer. You can either enter a username for the load balancer or provide a PSCredential object, such as an object that is returned by the Get-Credential cmdlet. When you type a username, you are prompted for a password. String Type Specify the type of cluster. Valid values: - default - remoteLM - localLM Note: The values are case sensitive. String Checker Specify the method used to check the status of the cluster. none – No checking is performed tcp – TCP Connect icmp – ICMP Ping String CheckerPort Set the port used for checking the cluster. This parameter is only relevant if the checker is set to tcp. Int32 Enable Enable/disable the cluster. 0 - Disable 1 - Enable String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Set-GeoCluster ClusterIp The IP address of the cluster. String ClusterName Specifies a user account that has permission to administer the load balancer. You can either enter a username for the load balancer or provide a PSCredential object, such as an object that is returned by the Get-Credential cmdlet. When you type a username, you are prompted for a password. String Type Specify the type of cluster. Valid values: - default - remoteLM - localLM Note: The values are case sensitive. String Checker Specify the method used to check the status of the cluster. none – No checking is performed tcp – TCP Connect icmp – ICMP Ping String CheckerPort Set the port used for checking the cluster. This parameter is only relevant if the checker is set to tcp. Int32 Enable Enable/disable the cluster. 0 - Disable 1 - Enable String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String ClusterIp The IP address of the cluster. String String ClusterName Specifies a user account that has permission to administer the load balancer. You can either enter a username for the load balancer or provide a PSCredential object, such as an object that is returned by the Get-Credential cmdlet. When you type a username, you are prompted for a password. String String Type Specify the type of cluster. Valid values: - default - remoteLM - localLM Note: The values are case sensitive. String String Checker Specify the method used to check the status of the cluster. none – No checking is performed tcp – TCP Connect icmp – ICMP Ping String String CheckerPort Set the port used for checking the cluster. This parameter is only relevant if the checker is set to tcp. Int32 Int32 Enable Enable/disable the cluster. 0 - Disable 1 - Enable String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Set-GeoCluster –IP 10.34.52.55 -Checker tcp -CheckerPort Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Index : 1 Status : Up Name : ExampleCluster ClusterVSAddress : IPAddress : 10.34.52.55 Checker : tcp CheckerPort : 80 Type : default Enable : Y LocationLatitude : LocationLongitude : Set-GeoClusterCoordinates Allows you to specify the location of a cluster. Set GeoClusterCoordinates Allows you to specify the location of a cluster. Set-GeoClusterCoordinates ClusterIp The IP address of the cluster. String LatSecs The latitude of the location. The latsecs and longsecs values should be entered as an integer containing the total seconds. This total seconds value is converted to degrees, minutes and seconds when displayed in the WUI. There are 60 seconds in a minute and 60 minutes in a degree. • Degrees = º • Minutes = ‘ • Seconds = “ • 60” = 1’ • 3600” = 1º • 3660 = 1º1’ • 3661 = 1º1’1” You can also represent this as a decimal value for degrees where the minutes and seconds are divided by 3600 to get the decimal value. Int32 LongSecs The longitude of the location. The latsecs and longsecs values should be entered as an integer containing the total seconds. This total seconds value is converted to degrees, minutes and seconds when displayed in the WUI. There are 60 seconds in a minute and 60 minutes in a degree. • Degrees = º • Minutes = ‘ • Seconds = “ • 60” = 1’ • 3600” = 1º • 3660 = 1º1’ • 3661 = 1º1’1” You can also represent this as a decimal value for degrees where the minutes and seconds are divided by 3600 to get the decimal value. Int32 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Set-GeoClusterCoordinates ClusterIp The IP address of the cluster. String LatSecs The latitude of the location. The latsecs and longsecs values should be entered as an integer containing the total seconds. This total seconds value is converted to degrees, minutes and seconds when displayed in the WUI. There are 60 seconds in a minute and 60 minutes in a degree. • Degrees = º • Minutes = ‘ • Seconds = “ • 60” = 1’ • 3600” = 1º • 3660 = 1º1’ • 3661 = 1º1’1” You can also represent this as a decimal value for degrees where the minutes and seconds are divided by 3600 to get the decimal value. Int32 LongSecs The longitude of the location. The latsecs and longsecs values should be entered as an integer containing the total seconds. This total seconds value is converted to degrees, minutes and seconds when displayed in the WUI. There are 60 seconds in a minute and 60 minutes in a degree. • Degrees = º • Minutes = ‘ • Seconds = “ • 60” = 1’ • 3600” = 1º • 3660 = 1º1’ • 3661 = 1º1’1” You can also represent this as a decimal value for degrees where the minutes and seconds are divided by 3600 to get the decimal value. Int32 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String ClusterIp The IP address of the cluster. String String LatSecs The latitude of the location. The latsecs and longsecs values should be entered as an integer containing the total seconds. This total seconds value is converted to degrees, minutes and seconds when displayed in the WUI. There are 60 seconds in a minute and 60 minutes in a degree. • Degrees = º • Minutes = ‘ • Seconds = “ • 60” = 1’ • 3600” = 1º • 3660 = 1º1’ • 3661 = 1º1’1” You can also represent this as a decimal value for degrees where the minutes and seconds are divided by 3600 to get the decimal value. Int32 Int32 LongSecs The longitude of the location. The latsecs and longsecs values should be entered as an integer containing the total seconds. This total seconds value is converted to degrees, minutes and seconds when displayed in the WUI. There are 60 seconds in a minute and 60 minutes in a degree. • Degrees = º • Minutes = ‘ • Seconds = “ • 60” = 1’ • 3600” = 1º • 3660 = 1º1’ • 3661 = 1º1’1” You can also represent this as a decimal value for degrees where the minutes and seconds are divided by 3600 to get the decimal value. Int32 Int32 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Set-GeoClusterCoordinates –IP 10.34.52.55 -LatSecs 5454 -LongSecs 5222 Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed. Cluster location updated; Data=} Return Code..: 200 Response.....: Command successfully executed. Cluster location updated Set-GeoCustomLocation Used to update an existing custom location. Set GeoCustomLocation Used to update an existing custom location. Set-GeoCustomLocation clOldName The existing name of the custom location. If the custom location name contains two or more words, the name must be surrounded by double-quotes such as “New York City”. String clNewName The new name of the custom location. If the custom location name contains two or more words, the name must be surrounded by double-quotes such as “New York City”. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Set-GeoCustomLocation clOldName The existing name of the custom location. If the custom location name contains two or more words, the name must be surrounded by double-quotes such as “New York City”. String clNewName The new name of the custom location. If the custom location name contains two or more words, the name must be surrounded by double-quotes such as “New York City”. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String clOldName The existing name of the custom location. If the custom location name contains two or more words, the name must be surrounded by double-quotes such as “New York City”. String String clNewName The new name of the custom location. If the custom location name contains two or more words, the name must be surrounded by double-quotes such as “New York City”. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Set-GeoCustomLocation -clNewName NewExampleLocation -clOldName ExampleLocation Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Set-GeoDNSSECStatus Enable/disable DNSSEC. Set GeoDNSSECStatus Use this command to enable or disable DNSSEC. Set-GeoDNSSECStatus status Specify whether to enable or disable DNSSEC. Valid values: disabled enabled String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Set-GeoDNSSECStatus status Specify whether to enable or disable DNSSEC. Valid values: disabled enabled String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String status Specify whether to enable or disable DNSSEC. Valid values: disabled enabled String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Set-GeoDNSSECStatus -status enabled Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Set-GeoFQDN Allows you to update the FQDN settings. Set GeoFQDN Allows you to update the FQDN settings. Set-GeoFQDN FQDN The name of the FQDN. This command cannot change the name of the FQDN - the FQDN name needs to be specified in order to modify the other FQDN settings. String SelectionCriteria Specify the selection procedure for addresses associated with the FQDN: RoundRobin WeightedRoundRobin FixedWeighting RealServerLoad Proximity LocationBased AllAvailable String SiteFailureDelay The number of minutes to wait after a failure before disabling. If this is not set, normal health checking is performed. Range: 0-1440 Int32 SiteRecoveryMode auto – Upon site recovery, bring the site back into operation immediately. manual – Once the site has failed, disable the site. Manual intervention is required to restore normal operation. String PublicRequest Restrict responses to clients from public IP addresses to specific classes of site. 0 – Public Sites Only (default) 1 – Prefer Public Sites 2 – Prefer Private Sites 3 – Any Sites String PrivateRequest Restrict responses to clients from private IP addresses to specific classes of site. 0 – Private Sites Only (default) 1 – Prefer Private Sites 2 – Prefer Public Sites 3 – Any Sites String Failover This parameter is only relevant if the SelectionCriteria is set to lb (Location Based). Enable/disable FQDN failover. 0 – Disabled 1 - Enabled Boolean LocalSettings Enabling this parameter provides two additional parameters for the FQDN – localttl and localsticky. Boolean localttl The Time To Live (TTL) value dictates how long the reply from the GEO LoadMaster can be cached by other DNS servers or client devices. The time interval is defined in seconds. This value should be as practically low as possible. The default value for this field is 10. Int32 localsticky Stickiness, also known as persistence, is the property that enables all name resolution requests from an individual client to be sent to the same resources until a specified period of time has elapsed. Int32 UnanimousChecks When this parameter is enabled, if any IP addresses fail health checking - the other FQDN IP addresses which belong to the same cluster will be forced down. Boolean LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Set-GeoFQDN FQDN The name of the FQDN. This command cannot change the name of the FQDN - the FQDN name needs to be specified in order to modify the other FQDN settings. String SelectionCriteria Specify the selection procedure for addresses associated with the FQDN: RoundRobin WeightedRoundRobin FixedWeighting RealServerLoad Proximity LocationBased AllAvailable String SiteFailureDelay The number of minutes to wait after a failure before disabling. If this is not set, normal health checking is performed. Range: 0-1440 Int32 SiteRecoveryMode auto – Upon site recovery, bring the site back into operation immediately. manual – Once the site has failed, disable the site. Manual intervention is required to restore normal operation. String PublicRequest Restrict responses to clients from public IP addresses to specific classes of site. 0 – Public Sites Only (default) 1 – Prefer Public Sites 2 – Prefer Private Sites 3 – Any Sites String PrivateRequest Restrict responses to clients from private IP addresses to specific classes of site. 0 – Private Sites Only (default) 1 – Prefer Private Sites 2 – Prefer Public Sites 3 – Any Sites String Failover This parameter is only relevant if the SelectionCriteria is set to lb (Location Based). Enable/disable FQDN failover. 0 – Disabled 1 - Enabled Boolean LocalSettings Enabling this parameter provides two additional parameters for the FQDN – localttl and localsticky. Boolean localttl The Time To Live (TTL) value dictates how long the reply from the GEO LoadMaster can be cached by other DNS servers or client devices. The time interval is defined in seconds. This value should be as practically low as possible. The default value for this field is 10. Int32 localsticky Stickiness, also known as persistence, is the property that enables all name resolution requests from an individual client to be sent to the same resources until a specified period of time has elapsed. Int32 UnanimousChecks When this parameter is enabled, if any IP addresses fail health checking - the other FQDN IP addresses which belong to the same cluster will be forced down. Boolean LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String FQDN The name of the FQDN. This command cannot change the name of the FQDN - the FQDN name needs to be specified in order to modify the other FQDN settings. String String SelectionCriteria Specify the selection procedure for addresses associated with the FQDN: RoundRobin WeightedRoundRobin FixedWeighting RealServerLoad Proximity LocationBased AllAvailable String String SiteFailureDelay The number of minutes to wait after a failure before disabling. If this is not set, normal health checking is performed. Range: 0-1440 Int32 Int32 SiteRecoveryMode auto – Upon site recovery, bring the site back into operation immediately. manual – Once the site has failed, disable the site. Manual intervention is required to restore normal operation. String String PublicRequest Restrict responses to clients from public IP addresses to specific classes of site. 0 – Public Sites Only (default) 1 – Prefer Public Sites 2 – Prefer Private Sites 3 – Any Sites String String PrivateRequest Restrict responses to clients from private IP addresses to specific classes of site. 0 – Private Sites Only (default) 1 – Prefer Private Sites 2 – Prefer Public Sites 3 – Any Sites String String Failover This parameter is only relevant if the SelectionCriteria is set to lb (Location Based). Enable/disable FQDN failover. 0 – Disabled 1 - Enabled Boolean Boolean LocalSettings Enabling this parameter provides two additional parameters for the FQDN – localttl and localsticky. Boolean Boolean localttl The Time To Live (TTL) value dictates how long the reply from the GEO LoadMaster can be cached by other DNS servers or client devices. The time interval is defined in seconds. This value should be as practically low as possible. The default value for this field is 10. Int32 Int32 localsticky Stickiness, also known as persistence, is the property that enables all name resolution requests from an individual client to be sent to the same resources until a specified period of time has elapsed. Int32 Int32 UnanimousChecks When this parameter is enabled, if any IP addresses fail health checking - the other FQDN IP addresses which belong to the same cluster will be forced down. Boolean Boolean LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String FailTime The number of minutes to wait after a failure before disabling. If this is not set, normal health checking is performed. Range: 0-1440 (minutes) This is a legacy parameter - use the SiteFailureDelay parameter instead. int32 int32 -------------------------- Example -------------------------- PS C:\> Set-GeoFQDN –FQDN Example.com –SelectionCriteria RoundRobin Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Set-GeoFQDNSiteAddress Allows you to update the details of the map. Set GeoFQDNSiteAddress Allows you to update the details of the map. Set-GeoFQDNSiteAddress FQDN The name of the FQDN. String SiteAddress IPv4 or IPv6 address of the map to be modified. String Checker Specify the type of checking to be performed on this IP address. Values are: None Icmp Ping Tcp Connect Cluster Checks String Weight This parameter is only relevant when the Selection Criteria is set to Weighted Round Robin or Fixed Weighting. Set the weight associated with an IP address. The address with the highest weight is returned. Int32 Enable Enable or disable the IP address. 0 - Disable 1 - Enable String Cluster Specify the cluster that is associated with this IP address. String Mapaddress This is only relevant when the Selection Criteria is set to Real Server Load, the Checker is set to Cluster Checks and the cluster is of type Remote LM or Local LM. Enter a Virtual Service IP address to be mapped from the relevant LoadMaster. String Mapport This is only relevant when the Selection Criteria is set to Real Server Load, the Checker is set to Cluster Checks and the cluster is of type Remote LM or Local LM. This parameter is used in conjunction with the MapAddress parameter to specify an IP address and port combination to be mapped. If this parameter is not set, the health check will check all Virtual Services with the same IP address as the one selected. If one of them is in an “Up” status, the FQDN will show as “Up”. If a port is specified, the health check will only check against the health of that Virtual Service when checking the health of the FQDN. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Set-GeoFQDNSiteAddress FQDN The name of the FQDN. String SiteAddress IPv4 or IPv6 address of the map to be modified. String Checker Specify the type of checking to be performed on this IP address. Values are: None Icmp Ping Tcp Connect Cluster Checks String Weight This parameter is only relevant when the Selection Criteria is set to Weighted Round Robin or Fixed Weighting. Set the weight associated with an IP address. The address with the highest weight is returned. Int32 Enable Enable or disable the IP address. 0 - Disable 1 - Enable String Cluster Specify the cluster that is associated with this IP address. String Mapaddress This is only relevant when the Selection Criteria is set to Real Server Load, the Checker is set to Cluster Checks and the cluster is of type Remote LM or Local LM. Enter a Virtual Service IP address to be mapped from the relevant LoadMaster. String Mapport This is only relevant when the Selection Criteria is set to Real Server Load, the Checker is set to Cluster Checks and the cluster is of type Remote LM or Local LM. This parameter is used in conjunction with the MapAddress parameter to specify an IP address and port combination to be mapped. If this parameter is not set, the health check will check all Virtual Services with the same IP address as the one selected. If one of them is in an “Up” status, the FQDN will show as “Up”. If a port is specified, the health check will only check against the health of that Virtual Service when checking the health of the FQDN. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String FQDN The name of the FQDN. String String SiteAddress IPv4 or IPv6 address of the map to be modified. String String Checker Specify the type of checking to be performed on this IP address. Values are: None Icmp Ping Tcp Connect Cluster Checks String String Weight This parameter is only relevant when the Selection Criteria is set to Weighted Round Robin or Fixed Weighting. Set the weight associated with an IP address. The address with the highest weight is returned. Int32 Int32 Enable Enable or disable the IP address. 0 - Disable 1 - Enable String String Cluster Specify the cluster that is associated with this IP address. String String Mapaddress This is only relevant when the Selection Criteria is set to Real Server Load, the Checker is set to Cluster Checks and the cluster is of type Remote LM or Local LM. Enter a Virtual Service IP address to be mapped from the relevant LoadMaster. String String Mapport This is only relevant when the Selection Criteria is set to Real Server Load, the Checker is set to Cluster Checks and the cluster is of type Remote LM or Local LM. This parameter is used in conjunction with the MapAddress parameter to specify an IP address and port combination to be mapped. If this parameter is not set, the health check will check all Virtual Services with the same IP address as the one selected. If one of them is in an “Up” status, the FQDN will show as “Up”. If a port is specified, the health check will only check against the health of that Virtual Service when checking the health of the FQDN. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Set-GeoFQDNSiteAddress –FQDN Example.com -IP 10.134.33.2 -checker "Icmp Ping" Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Set-GeoFQDNSiteCheckerAddress Allows you to set the address and port used to health check the IP address. Set GeoFQDNSiteCheckerAddress Allows you to set the address and port used to health check the IP address. Set-GeoFQDNSiteCheckerAddress FQDN The name of the FQDN. String SiteAddress The address of the site to change the checker address for. String CheckerIP The IP address to be used to health check the IP address. Setting this to an empty string will unset the checker address. String CheckerPort The port to be used to health check the IP address. Setting this parameter to an empty string will default the checker port to 80. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Set-GeoFQDNSiteCheckerAddress FQDN The name of the FQDN. String SiteAddress The address of the site to change the checker address for. String CheckerIP The IP address to be used to health check the IP address. Setting this to an empty string will unset the checker address. String CheckerPort The port to be used to health check the IP address. Setting this parameter to an empty string will default the checker port to 80. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String FQDN The name of the FQDN. String String SiteAddress The address of the site to change the checker address for. String String CheckerIP The IP address to be used to health check the IP address. Setting this to an empty string will unset the checker address. String String CheckerPort The port to be used to health check the IP address. Setting this parameter to an empty string will default the checker port to 80. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Set-GeoFQDNSiteCheckerAddress -CheckerIP 10.134.44.55 -FQDN Example.com -SiteAddress 10.134.33.2 -Port 80 Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Status : Down SelectionCriteria : RoundRobin SiteRecoveryMode : auto Mapping : 1 LocalSettings : 0 UnanimousChecks : N Map : @{Status=Down; Index=1; IPAddress=10.134.33.2; Checker=icmp; CheckerPort=80; CheckerAddr=10.134.44.55; Weight=1000; Enable=Y; LocationLatitude=; LocationLongitude=} Failover : N SiteFailureDelay : 0 Fqdn : Example.com. PrivateRequest : 0 PublicRequest : 0 Set-GeoFQDNSiteCoordinates Allows you to set the latitude and longitude of an IP address. Set GeoFQDNSiteCoordinates Allows you to set the latitude and longitude of an IP address when the Selection Criteria of the FQDN is set to Proximity. Set-GeoFQDNSiteCoordinates FQDN The name of the FQDN. String SiteAddress IP address of the map to be modified. String Lat The latitude of the IP address in the format of total seconds. The lat and long values should be entered as an integer containing the total seconds. This total seconds value is converted to degrees, minutes and seconds when displayed in the WUI. There are 60 seconds in a minute and 60 minutes in a degree. • Degrees = º • Minutes = ‘ • Seconds = “ • 60” = 1’ • 3600” = 1º • 3660 = 1º1’ • 3661 = 1º1’1” You can also represent this as a decimal value for degrees where the minutes and seconds are divided by 3600 to get the decimal value. Int32 Long The longitude of the IP address in the format of total seconds. The lat and long values should be entered as an integer containing the total seconds. This total seconds value is converted to degrees, minutes and seconds when displayed in the WUI. There are 60 seconds in a minute and 60 minutes in a degree. • Degrees = º • Minutes = ‘ • Seconds = “ • 60” = 1’ • 3600” = 1º • 3660 = 1º1’ • 3661 = 1º1’1” You can also represent this as a decimal value for degrees where the minutes and seconds are divided by 3600 to get the decimal value. Int32 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Set-GeoFQDNSiteCoordinates FQDN The name of the FQDN. String SiteAddress IP address of the map to be modified. String Lat The latitude of the IP address in the format of total seconds. The lat and long values should be entered as an integer containing the total seconds. This total seconds value is converted to degrees, minutes and seconds when displayed in the WUI. There are 60 seconds in a minute and 60 minutes in a degree. • Degrees = º • Minutes = ‘ • Seconds = “ • 60” = 1’ • 3600” = 1º • 3660 = 1º1’ • 3661 = 1º1’1” You can also represent this as a decimal value for degrees where the minutes and seconds are divided by 3600 to get the decimal value. Int32 Long The longitude of the IP address in the format of total seconds. The lat and long values should be entered as an integer containing the total seconds. This total seconds value is converted to degrees, minutes and seconds when displayed in the WUI. There are 60 seconds in a minute and 60 minutes in a degree. • Degrees = º • Minutes = ‘ • Seconds = “ • 60” = 1’ • 3600” = 1º • 3660 = 1º1’ • 3661 = 1º1’1” You can also represent this as a decimal value for degrees where the minutes and seconds are divided by 3600 to get the decimal value. Int32 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String FQDN The name of the FQDN. String String SiteAddress IP address of the map to be modified. String String Lat The latitude of the IP address in the format of total seconds. The lat and long values should be entered as an integer containing the total seconds. This total seconds value is converted to degrees, minutes and seconds when displayed in the WUI. There are 60 seconds in a minute and 60 minutes in a degree. • Degrees = º • Minutes = ‘ • Seconds = “ • 60” = 1’ • 3600” = 1º • 3660 = 1º1’ • 3661 = 1º1’1” You can also represent this as a decimal value for degrees where the minutes and seconds are divided by 3600 to get the decimal value. Int32 Int32 Long The longitude of the IP address in the format of total seconds. The lat and long values should be entered as an integer containing the total seconds. This total seconds value is converted to degrees, minutes and seconds when displayed in the WUI. There are 60 seconds in a minute and 60 minutes in a degree. • Degrees = º • Minutes = ‘ • Seconds = “ • 60” = 1’ • 3600” = 1º • 3660 = 1º1’ • 3661 = 1º1’1” You can also represent this as a decimal value for degrees where the minutes and seconds are divided by 3600 to get the decimal value. Int32 Int32 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String IP IP address of the map to be modified. string string -------------------------- Example -------------------------- PS C:\> Set-GeoFQDNSiteCoordinates –FQDN Example.com -IP 10.134.33.2 -Lat 3000 -Long 3000 Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed. Map location updated.; Data=} Return Code..: 200 Response.....: Command successfully executed. Map location updated. Set-GeoFQDNSiteCountry Assign a country/continent to an IP address. Set GeoFQDNSiteCountry Assigns a country or continent to an IP address in an FQDN which has the Selection Criteria set to Location Based. Set-GeoFQDNSiteCountry FQDN The name of the FQDN. String SiteAddress The address of the map to be modified. String CountryCode Two-letter country or continent code for the country/continent to be assigned. The country code and continent codes used are the standard ISO codes. To specify everywhere as the country, type ALL as the country code and set the IsContinent parameter to yes. String IsContinent Some country codes and continent codes are the same, for example AF could mean Africa or Afghanistan. You must specify in this parameter if the code is for a country or continent. yes – code is for a continent no – code is for a country String CustomLocation The name of an existing custom location. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Set-GeoFQDNSiteCountry FQDN The name of the FQDN. String SiteAddress The address of the map to be modified. String CountryCode Two-letter country or continent code for the country/continent to be assigned. The country code and continent codes used are the standard ISO codes. To specify everywhere as the country, type ALL as the country code and set the IsContinent parameter to yes. String IsContinent Some country codes and continent codes are the same, for example AF could mean Africa or Afghanistan. You must specify in this parameter if the code is for a country or continent. yes – code is for a continent no – code is for a country String CustomLocation The name of an existing custom location. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String FQDN The name of the FQDN. String String SiteAddress The address of the map to be modified. String String CountryCode Two-letter country or continent code for the country/continent to be assigned. The country code and continent codes used are the standard ISO codes. To specify everywhere as the country, type ALL as the country code and set the IsContinent parameter to yes. String String IsContinent Some country codes and continent codes are the same, for example AF could mean Africa or Afghanistan. You must specify in this parameter if the code is for a country or continent. yes – code is for a continent no – code is for a country String String CustomLocation The name of an existing custom location. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Set-GeoFQDNSiteCountry -FQDN Example.com -SiteAddress 10.134.33.2 -CountryCode IE -IsContinent no Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed. Country/Continent updated.; Data=} Return Code..: 200 Response.....: Command successfully executed. Country/Continent updated. Set-GeoIPBlacklistDatabaseConfiguration Configure the GEO IP blacklist database settings. Set GeoIPBlacklistDatabaseConfiguration This command can be run to set the GEO IP blacklist database settings, such as: - The auto-update time - The auto-install setting - The auto-install time Set-GeoIPBlacklistDatabaseConfiguration DatabaseAutoUpdate Enable or disable automatic downloading of updates. SwitchParameter LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String Set-GeoIPBlacklistDatabaseConfiguration DatabaseAutoInstall Enable or disable automatic installation of the updates. SwitchParameter DatabaseInstallTimeHour Set the time of the automatic installation. The hour is the hour value from the 24-hour clock (0-23), for example 13 is 1pm. Int32 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String DatabaseAutoUpdate Enable or disable automatic downloading of updates. SwitchParameter SwitchParameter LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String InformationAction ActionPreference ActionPreference InformationVariable String String DatabaseAutoInstall Enable or disable automatic installation of the updates. SwitchParameter SwitchParameter DatabaseInstallTimeHour Set the time of the automatic installation. The hour is the hour value from the 24-hour clock (0-23), for example 13 is 1pm. Int32 Int32 You can only use one login method - either certificate or credential. You cannot use both. -------------------------- Example -------------------------- PS C:\> Set-GeoIPBlacklistDatabaseConfiguration -DatabaseAutoInstall -DatabaseInstallTimeHour 14 Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Set-GeoIPRangeCoordinates Allows you to change the location of an IP address. Set GeoIPRangeCoordinates Allows you to change the location of an IP address. Set-GeoIPRangeCoordinates IP The IP address to be modified. String Lat The latitude of the location. This parameter accepts values from -324000 (which converts to 90 degrees south) to 324000 (which converts to 90 degrees north). The lat and long values should be entered as an integer containing the total seconds. This total seconds value is converted to degrees, minutes and seconds when displayed in the WUI. There are 60 seconds in a minute and 60 minutes in a degree. • Degrees = º • Minutes = ‘ • Seconds = “ • 60” = 1’ • 3600” = 1º • 3660 = 1º1’ • 3661 = 1º1’1” You can also represent this as a decimal value for degrees where the minutes and seconds are divided by 3600 to get the decimal value. Int32 Long The longitude of the location. This parameter accepts values from -648000 (which converts to 180 degrees East) to 648000 which converts to 180 degrees West). The lat and long values should be entered as an integer containing the total seconds. This total seconds value is converted to degrees, minutes and seconds when displayed in the WUI. There are 60 seconds in a minute and 60 minutes in a degree. • Degrees = º • Minutes = ‘ • Seconds = “ • 60” = 1’ • 3600” = 1º • 3660 = 1º1’ • 3661 = 1º1’1” You can also represent this as a decimal value for degrees where the minutes and seconds are divided by 3600 to get the decimal value. Int32 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Set-GeoIPRangeCoordinates IP The IP address to be modified. String Lat The latitude of the location. This parameter accepts values from -324000 (which converts to 90 degrees south) to 324000 (which converts to 90 degrees north). The lat and long values should be entered as an integer containing the total seconds. This total seconds value is converted to degrees, minutes and seconds when displayed in the WUI. There are 60 seconds in a minute and 60 minutes in a degree. • Degrees = º • Minutes = ‘ • Seconds = “ • 60” = 1’ • 3600” = 1º • 3660 = 1º1’ • 3661 = 1º1’1” You can also represent this as a decimal value for degrees where the minutes and seconds are divided by 3600 to get the decimal value. Int32 Long The longitude of the location. This parameter accepts values from -648000 (which converts to 180 degrees East) to 648000 which converts to 180 degrees West). The lat and long values should be entered as an integer containing the total seconds. This total seconds value is converted to degrees, minutes and seconds when displayed in the WUI. There are 60 seconds in a minute and 60 minutes in a degree. • Degrees = º • Minutes = ‘ • Seconds = “ • 60” = 1’ • 3600” = 1º • 3660 = 1º1’ • 3661 = 1º1’1” You can also represent this as a decimal value for degrees where the minutes and seconds are divided by 3600 to get the decimal value. Int32 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String IP The IP address to be modified. String String Lat The latitude of the location. This parameter accepts values from -324000 (which converts to 90 degrees south) to 324000 (which converts to 90 degrees north). The lat and long values should be entered as an integer containing the total seconds. This total seconds value is converted to degrees, minutes and seconds when displayed in the WUI. There are 60 seconds in a minute and 60 minutes in a degree. • Degrees = º • Minutes = ‘ • Seconds = “ • 60” = 1’ • 3600” = 1º • 3660 = 1º1’ • 3661 = 1º1’1” You can also represent this as a decimal value for degrees where the minutes and seconds are divided by 3600 to get the decimal value. Int32 Int32 Long The longitude of the location. This parameter accepts values from -648000 (which converts to 180 degrees East) to 648000 which converts to 180 degrees West). The lat and long values should be entered as an integer containing the total seconds. This total seconds value is converted to degrees, minutes and seconds when displayed in the WUI. There are 60 seconds in a minute and 60 minutes in a degree. • Degrees = º • Minutes = ‘ • Seconds = “ • 60” = 1’ • 3600” = 1º • 3660 = 1º1’ • 3661 = 1º1’1” You can also represent this as a decimal value for degrees where the minutes and seconds are divided by 3600 to get the decimal value. Int32 Int32 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Set-GeoIPRangeCoordinates –IP 10.154.11.55 -Lat 5875 -Long 6565 Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed. IP range location updated; Data=} Return Code..: 200 Response.....: Command successfully executed. IP range location updated Set-GeoIPRangeCountry Assigns a country to an IP address. Set GeoIPRangeCountry Assigns a country to an IP address. Set-GeoIPRangeCountry IP The IP address to be modified. String CountryCode Two-character country code, for example IE is Ireland. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Set-GeoIPRangeCountry IP The IP address to be modified. String CountryCode Two-character country code, for example IE is Ireland. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String IP The IP address to be modified. String String CountryCode Two-character country code, for example IE is Ireland. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Set-GeoIPRangeCountry –CountryCode US -IP 10.154.11.55 Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed. IP range country updated; Data=} Return Code..: 200 Response.....: Command successfully executed. IP range country updated Set-GeoIPRangeCustomLocation Assigns a custom location to an IP address. Set GeoIPRangeCustomLocation Assigns a custom location to an IP address. Set-GeoIPRangeCustomLocation IP The IP address to be modified. String CustomLoc The name of an existing custom location. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Set-GeoIPRangeCustomLocation IP The IP address to be modified. String CustomLoc The name of an existing custom location. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String IP The IP address to be modified. String String CustomLoc The name of an existing custom location. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Set-GeoIPRangeCustomLocation -CustomLoc "US West" -IP 10.11.0.14 Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed. IP range country updated; Data=} Return Code..: 200 Response.....: Command successfully executed. IP range country updated Set-GeoMiscParameter Update the miscellaneous GEO parameters. Set GeoMiscParameter Update the miscellaneous GEO parameters, such as those relating to the Source of Authority, Resource Check Parameters and Stickiness. Set-GeoMiscParameter SourceOfAuthority Specify the response set for Source Of Authority requests. String NameSrv Specify the response set for Name Server requests String SOAEmail Specify the response email string sent for SOA requests. String TTL Specify the Time To Live (TTL) of the responses returned by the LoadMaster. The default value for this is 10. The range is 1-86400. Int32 Persist This parameter corresponds to the Stickiness field in the WUI. Specify how long a specific request will be returned to a host. Int32 CheckInterval Specify how often to check the devices. Range: 9-3600 Note: The interval value must be greater than the ConnTimeout value multiplied by the RetryAttempts value (Interval > Timeout * Retry + 1). This is to ensure that the next health check does not start before the previous one completes. If the timeout or retry values are increased to a value that breaks this rule, the interval value will be automatically increased. Int32 ConnTimeout Specify the timeout value for the check request. Range: 4-60 Int32 RetryAttempts Specify the number of times the check will be retried before the device is marked as failed. Int32 Zone Specify the zone name. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Set-GeoMiscParameter SourceOfAuthority Specify the response set for Source Of Authority requests. String NameSrv Specify the response set for Name Server requests String SOAEmail Specify the response email string sent for SOA requests. String TTL Specify the Time To Live (TTL) of the responses returned by the LoadMaster. The default value for this is 10. The range is 1-86400. Int32 Persist This parameter corresponds to the Stickiness field in the WUI. Specify how long a specific request will be returned to a host. Int32 CheckInterval Specify how often to check the devices. Range: 9-3600 Note: The interval value must be greater than the ConnTimeout value multiplied by the RetryAttempts value (Interval > Timeout * Retry + 1). This is to ensure that the next health check does not start before the previous one completes. If the timeout or retry values are increased to a value that breaks this rule, the interval value will be automatically increased. Int32 ConnTimeout Specify the timeout value for the check request. Range: 4-60 Int32 RetryAttempts Specify the number of times the check will be retried before the device is marked as failed. Int32 Zone Specify the zone name. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String SourceOfAuthority Specify the response set for Source Of Authority requests. String String NameSrv Specify the response set for Name Server requests String String SOAEmail Specify the response email string sent for SOA requests. String String TTL Specify the Time To Live (TTL) of the responses returned by the LoadMaster. The default value for this is 10. The range is 1-86400. Int32 Int32 Persist This parameter corresponds to the Stickiness field in the WUI. Specify how long a specific request will be returned to a host. Int32 Int32 CheckInterval Specify how often to check the devices. Range: 9-3600 Note: The interval value must be greater than the ConnTimeout value multiplied by the RetryAttempts value (Interval > Timeout * Retry + 1). This is to ensure that the next health check does not start before the previous one completes. If the timeout or retry values are increased to a value that breaks this rule, the interval value will be automatically increased. Int32 Int32 ConnTimeout Specify the timeout value for the check request. Range: 4-60 Int32 Int32 RetryAttempts Specify the number of times the check will be retried before the device is marked as failed. Int32 Int32 Zone Specify the zone name. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Set-GeoMiscParameter -ConnTimeout 50 Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. soa : @{TTL=10; persist=60; Zone=; SourceOfAuthority=; NameSrv=; SOAEmail=} check : @{CheckInterval=120; ConnTimeout=50; RetryAttempts=2} Set-HAOption WARNING: This function is deprecated. Use the following command instead: Set-LmHAConfiguration Set HAOption WARNING: This function is deprecated. Use the following command instead: Set-LmHAConfiguration Set-HAOption hatimeout Int16 hawait Int16 havhid Int16 haprefered String haif Int16 hal4update Boolean hal7update Boolean LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String Set-HAOption hatimeout Int16 hawait Int16 havhid Int16 haprefered String haif Int16 hal4update Boolean hal7update Boolean LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String hatimeout Int16 Int16 hawait Int16 Int16 havhid Int16 Int16 haprefered String String haif Int16 Int16 hal4update Boolean Boolean hal7update Boolean Boolean LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String Set-Interface WARNING: This function is deprecated. Use the following command instead: Set-NetworkInterface Set Interface WARNING: This function is deprecated. Use the following command instead: Set-NetworkInterface Set-Interface InterfaceID Int16 IPAddress String MTU Int32 HACheck Boolean GWIface Boolean clupdate Boolean GeoTraffic Boolean BondMode String Partner String Shared String LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String Set-Interface InterfaceID Int16 IPAddress String MTU Int32 HACheck Boolean GWIface Boolean clupdate Boolean GeoTraffic Boolean BondMode String Partner String Shared String LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String InterfaceID Int16 Int16 IPAddress String String MTU Int32 Int32 HACheck Boolean Boolean GWIface Boolean Boolean clupdate Boolean Boolean GeoTraffic Boolean Boolean BondMode String String Partner String String Shared String String LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String Set-L7Configuration WARNING: This function is deprecated. Use the following command instead: Set-AdcL7Configuration Set L7Configuration WARNING: This function is deprecated. Use the following command instead: Set-AdcL7Configuration Set-L7Configuration ScalingOver64KConnections Boolean AlwaysCheckPersist String AddPortToActiveCookie Boolean RFCConform Boolean CloseOnError Boolean AddViaHeaderInCacheResponses Boolean RSAreLocal Boolean DropOnRSFail Boolean DropAtDrainEnd Boolean L7AuthTimeoutSecs Int16 L7ClientTokenTimeoutSecs Int16 L7ConnectionDrainTimeoutSecs Int32 AdditionalL7Header String OneHundredContinueHandling String AllowEmptyPosts Boolean AllowEmptyHttpHeaders Boolean ForceCompleteRSMatch Boolean SlowStart Int16 ShareSubVSPersistance Boolean LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String Set-L7Configuration ScalingOver64KConnections Boolean AlwaysCheckPersist String AddPortToActiveCookie Boolean RFCConform Boolean CloseOnError Boolean AddViaHeaderInCacheResponses Boolean RSAreLocal Boolean DropOnRSFail Boolean DropAtDrainEnd Boolean L7AuthTimeoutSecs Int16 L7ClientTokenTimeoutSecs Int16 L7ConnectionDrainTimeoutSecs Int32 AdditionalL7Header String OneHundredContinueHandling String AllowEmptyPosts Boolean AllowEmptyHttpHeaders Boolean ForceCompleteRSMatch Boolean SlowStart Int16 ShareSubVSPersistance Boolean LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String ScalingOver64KConnections Boolean Boolean AlwaysCheckPersist String String AddPortToActiveCookie Boolean Boolean RFCConform Boolean Boolean CloseOnError Boolean Boolean AddViaHeaderInCacheResponses Boolean Boolean RSAreLocal Boolean Boolean DropOnRSFail Boolean Boolean DropAtDrainEnd Boolean Boolean L7AuthTimeoutSecs Int16 Int16 L7ClientTokenTimeoutSecs Int16 Int16 L7ConnectionDrainTimeoutSecs Int32 Int32 AdditionalL7Header String String OneHundredContinueHandling String String AllowEmptyPosts Boolean Boolean AllowEmptyHttpHeaders Boolean Boolean ForceCompleteRSMatch Boolean Boolean SlowStart Int16 Int16 ShareSubVSPersistance Boolean Boolean LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String Set-LdapEndpoint Modify an existing LDAP endpoint. Set LdapEndpoint These LDAP endpoints may be used in three different areas: • Health checks • SSO domains • WUI authentication Set-LdapEndpoint Name The name of the LDAP endpoint to be modified. String Server Specify the address, or addresses, of the LDAP server to be used. You can also specify a port number, if desired. Separate multiple addresses with a space. String LdapProtocol Specify the transport protocol to use when communicating with the LDAP server. Valid values: 0 – Unencrypted (default) 1 – StartTLS 2 – LDAPS String VInterval Specify how often to revalidate the user the with the LDAP server. Range: 10 – 86400 seconds Default: 60 Int16 ReferralCount Multiple hops may increase authentication latency. There is a performance impact that depends on the number and depth of referrals required in your configuration. You must have intimate knowledge of your Active Directory structure to set the referral limit appropriately. The same credentials are used for all lookups, and so on. The use of Active Directory Global Catalog (GC) is the preferred configuration as the primary means of resolution instead of enabling LDAP referral chasing. A GC query can be used to query the GC cache instead of relying on LDAP and the referral process. Using Active Directory GC has little or no performance drag on the LoadMaster. For steps on how to add/remove the GC, refer to the following TechNet article: https://technet.microsoft.com/en-us/library/cc755257(v=ws.11).aspx Int16 AdminUser Specify the username of an administrator user. The username that will be used to check the LDAP server. String AdminPass Specify the password for the specified administrator user. The password that will be used to check the LDAP server. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Set-LdapEndpoint Name The name of the LDAP endpoint to be modified. String Server Specify the address, or addresses, of the LDAP server to be used. You can also specify a port number, if desired. Separate multiple addresses with a space. String LdapProtocol Specify the transport protocol to use when communicating with the LDAP server. Valid values: 0 – Unencrypted (default) 1 – StartTLS 2 – LDAPS String VInterval Specify how often to revalidate the user the with the LDAP server. Range: 10 – 86400 seconds Default: 60 Int16 ReferralCount Multiple hops may increase authentication latency. There is a performance impact that depends on the number and depth of referrals required in your configuration. You must have intimate knowledge of your Active Directory structure to set the referral limit appropriately. The same credentials are used for all lookups, and so on. The use of Active Directory Global Catalog (GC) is the preferred configuration as the primary means of resolution instead of enabling LDAP referral chasing. A GC query can be used to query the GC cache instead of relying on LDAP and the referral process. Using Active Directory GC has little or no performance drag on the LoadMaster. For steps on how to add/remove the GC, refer to the following TechNet article: https://technet.microsoft.com/en-us/library/cc755257(v=ws.11).aspx Int16 AdminUser Specify the username of an administrator user. The username that will be used to check the LDAP server. String AdminPass Specify the password for the specified administrator user. The password that will be used to check the LDAP server. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String Name The name of the LDAP endpoint to be modified. String String Server Specify the address, or addresses, of the LDAP server to be used. You can also specify a port number, if desired. Separate multiple addresses with a space. String String LdapProtocol Specify the transport protocol to use when communicating with the LDAP server. Valid values: 0 – Unencrypted (default) 1 – StartTLS 2 – LDAPS String String VInterval Specify how often to revalidate the user the with the LDAP server. Range: 10 – 86400 seconds Default: 60 Int16 Int16 ReferralCount Multiple hops may increase authentication latency. There is a performance impact that depends on the number and depth of referrals required in your configuration. You must have intimate knowledge of your Active Directory structure to set the referral limit appropriately. The same credentials are used for all lookups, and so on. The use of Active Directory Global Catalog (GC) is the preferred configuration as the primary means of resolution instead of enabling LDAP referral chasing. A GC query can be used to query the GC cache instead of relying on LDAP and the referral process. Using Active Directory GC has little or no performance drag on the LoadMaster. For steps on how to add/remove the GC, refer to the following TechNet article: https://technet.microsoft.com/en-us/library/cc755257(v=ws.11).aspx Int16 Int16 AdminUser Specify the username of an administrator user. The username that will be used to check the LDAP server. String String AdminPass Specify the password for the specified administrator user. The password that will be used to check the LDAP server. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Set-LdapEndpoint -Name ExampleLDAPEndpoint -Server "10.154.11.24 10.154.22.45" Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Set-LicenseInitialPassword Set the password for the default bal LoadMaster user when initially configuring the LoadMaster. Set LicenseInitialPassword Set the password for the default bal LoadMaster user when initially configuring the LoadMaster. Set-LicenseInitialPassword Passwd The desired password for the default bal LoadMaster user. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Passwd The desired password for the default bal LoadMaster user. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String -------------------------- Example -------------------------- PS C:\> Set-LicenseInitialPassword -Passwd 2fourall Example Output: Full response: Command successfully executed. Return Code..: 200 Response.....: Command successfully executed Data field...: Set-LmAFEConfiguration Allows you to set the values of Cache, Compression and IPS options. Set LmAFEConfiguration Allows you to set the values of Cache, Compression and IPS options. Set-LmAFEConfiguration CacheSize Specifies the cache size. Int32 HostCache Enable or disable using the host cache. Boolean DetectionLevel Specify how paranoid the detection rules should be. Valid options are: Low - Only logging, no rejection Default - Only Critical problems are rejected High - Serious and Critical problems are rejected Paranoid - All problems detected are rejected String LimitInput Limit the number of connections. Int64 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Set-LmAFEConfiguration CacheSize Specifies the cache size. Int32 HostCache Enable or disable using the host cache. Boolean DetectionLevel Specify how paranoid the detection rules should be. Valid options are: Low - Only logging, no rejection Default - Only Critical problems are rejected High - Serious and Critical problems are rejected Paranoid - All problems detected are rejected String LimitInput Limit the number of connections. Int64 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String CacheSize Specifies the cache size. Int32 Int32 HostCache Enable or disable using the host cache. Boolean Boolean DetectionLevel Specify how paranoid the detection rules should be. Valid options are: Low - Only logging, no rejection Default - Only Critical problems are rejected High - Serious and Critical problems are rejected Paranoid - All problems detected are rejected String String LimitInput Limit the number of connections. Int64 Int64 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String Paranoia Sets the sensitivity of IDS detection. int16 int16 -------------------------- Example -------------------------- PS C:\> Set-LmAFEConfiguration -CacheSize 150 -HostCache $True -LimitInput 10 -Paranoia 2 Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Set-LmAwsHAConfiguration Set the Amazon Web Services (AWS) High Availability (HA) options. Set LmAwsHAConfiguration Set the AWS HA options, such as the health check port and partner address. Set-LmAwsHAConfiguration Partner Address of the HA partner. String HealthCheckPort The port over which the health check is run. This needs to be the same on both the master and the slave units in order for HA to function correctly. String haprefered There are two possible values to set: 0 - No Preferred Host: Each unit takes over when the other unit fails. No switchover is performed when the partner is restarted. 1 - Prefer Master: The HA1 (master) unit always takes over. This is the default option. Int32 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Set-LmAwsHAConfiguration Partner Address of the HA partner. String HealthCheckPort The port over which the health check is run. This needs to be the same on both the master and the slave units in order for HA to function correctly. String haprefered There are two possible values to set: 0 - No Preferred Host: Each unit takes over when the other unit fails. No switchover is performed when the partner is restarted. 1 - Prefer Master: The HA1 (master) unit always takes over. This is the default option. Int32 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String Partner Address of the HA partner. String String HealthCheckPort The port over which the health check is run. This needs to be the same on both the master and the slave units in order for HA to function correctly. String String haprefered There are two possible values to set: 0 - No Preferred Host: Each unit takes over when the other unit fails. No switchover is performed when the partner is restarted. 1 - Prefer Master: The HA1 (master) unit always takes over. This is the default option. Int32 Int32 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String Hcp The port over which the health check is run. This needs to be the same on both the master and the slave units in order for HA to function correctly. string string -------------------------- Example -------------------------- PS C:\> Set-ClusterAwsHAConfiguration –Hcp 443 –Partner 10.141.44.22 Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Hcp: 443 Set-LmAwsHAMode Allows you to specify the Amazon Web Services (AWS) HA mode. Set LmAwsHAMode Allows you to specify the Amazon Web Services (AWS) HA mode, for example, master HA Mode, slave HA Mode or Non-HA mode. Set-LmAwsHAMode HAMode Specifies the HA mode. Valid values are: - master - slave - single String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Set-LmAwsHAMode HAMode Specifies the HA mode. Valid values are: - master - slave - single String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String HAMode Specifies the HA mode. Valid values are: - master - slave - single String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Set-LmAwsHAMode –HAMode master Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Set-LmAzureHAConfiguration Configure the HA options for an Azure LoadMaster. Set LmAzureHAConfiguration Allows you to set the other Azure HA options: health check port and partner address. Run this command on the master LoadMaster. Set-LmAzureHAConfiguration Partner The internal IP address of the HA partner. String HealthCheckPort Set the port over which the health check will be run. The port must be the same on both the master and slave unit for HA to function correctly. String Hapreferred By default, neither partner in a HA cluster has priority. When a machine restarts after a switchover that machine becomes a slave. Specifying a preferred host means that when this machine restarts it will always become the master and the partner will revert to slave mode. There are two possible values to set: 0 - No Preferred Host: Each unit takes over when the other unit fails. No switchover is performed when the partner is restarted. 1 - Prefer Master: The HA1 (master) unit always takes over. This is the default option. Int32 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Set-LmAzureHAConfiguration Partner The internal IP address of the HA partner. String HealthCheckPort Set the port over which the health check will be run. The port must be the same on both the master and slave unit for HA to function correctly. String Hapreferred By default, neither partner in a HA cluster has priority. When a machine restarts after a switchover that machine becomes a slave. Specifying a preferred host means that when this machine restarts it will always become the master and the partner will revert to slave mode. There are two possible values to set: 0 - No Preferred Host: Each unit takes over when the other unit fails. No switchover is performed when the partner is restarted. 1 - Prefer Master: The HA1 (master) unit always takes over. This is the default option. Int32 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String Partner The internal IP address of the HA partner. String String HealthCheckPort Set the port over which the health check will be run. The port must be the same on both the master and slave unit for HA to function correctly. String String Hapreferred By default, neither partner in a HA cluster has priority. When a machine restarts after a switchover that machine becomes a slave. Specifying a preferred host means that when this machine restarts it will always become the master and the partner will revert to slave mode. There are two possible values to set: 0 - No Preferred Host: Each unit takes over when the other unit fails. No switchover is performed when the partner is restarted. 1 - Prefer Master: The HA1 (master) unit always takes over. This is the default option. Int32 Int32 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String haprefered There are two possible values to set: 0 - No Preferred Host: Each unit takes over when the other unit fails. No switchover is performed when the partner is restarted. 1 - Prefer Master: The HA1 (master) unit always takes over. This is the default option. int32 int32 Hcp The port over which the health check is run. This needs to be the same on both the master and the slave units in order for HA to function correctly. string string -------------------------- Example -------------------------- PS C:\> Set-ClusterAzureHAConfiguration –HealthCheckPort 8443 Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Hcp: 8443 Set-LmAzureHAMode Allows you to specify the Azure HA mode. Set LmAzureHAMode Allows you to specify the Azure HA mode. For example, Master HA Mode, Slave HA Mode or Non-HA Mode (single). Set-LmAzureHAMode HAMode Specifies the HA mode. Valid options are master, slave or single. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Set-LmAzureHAMode HAMode Specifies the HA mode. Valid options are master, slave or single. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String HAMode Specifies the HA mode. Valid options are master, slave or single. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Set-ClusterAzureHAMode –HAMode master Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Set-LmBackupConfiguration Allows you to set the values of the Automated Backup options. Set LmBackupConfiguration Allows you to set the values of the Automated Backup options. Set-LmBackupConfiguration BackupEnable Specifies if scheduled backups are enabled. String BackupHour For scheduled backups, this parameter specifies the "hour" number (0-23). Int16 BackupMinute For scheduled backups, this parameter specifies the "minute" number (0-59). Int16 BackupDay For scheduled backups, this parameter specifies the "day" number (0-7). Int16 BackupMethod Specify the file transfer method for automated backups. Valid values are: Ftp SCP String BackupUser Specifies the user account that has access to save the backup file. String BackupPassword Specifies the password for the user account that has access to save the backup file. String BackupHost Specifies the host to save the backup file to. String BackupPath Specifies the path on the remote host for saving the backup file. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Set-LmBackupConfiguration BackupEnable Specifies if scheduled backups are enabled. String BackupHour For scheduled backups, this parameter specifies the "hour" number (0-23). Int16 BackupMinute For scheduled backups, this parameter specifies the "minute" number (0-59). Int16 BackupDay For scheduled backups, this parameter specifies the "day" number (0-7). Int16 BackupMethod Specify the file transfer method for automated backups. Valid values are: Ftp SCP String BackupUser Specifies the user account that has access to save the backup file. String BackupPassword Specifies the password for the user account that has access to save the backup file. String BackupHost Specifies the host to save the backup file to. String BackupPath Specifies the path on the remote host for saving the backup file. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String BackupEnable Specifies if scheduled backups are enabled. String String BackupHour For scheduled backups, this parameter specifies the "hour" number (0-23). Int16 Int16 BackupMinute For scheduled backups, this parameter specifies the "minute" number (0-59). Int16 Int16 BackupDay For scheduled backups, this parameter specifies the "day" number (0-7). Int16 Int16 BackupMethod Specify the file transfer method for automated backups. Valid values are: Ftp SCP String String BackupUser Specifies the user account that has access to save the backup file. String String BackupPassword Specifies the password for the user account that has access to save the backup file. String String BackupHost Specifies the host to save the backup file to. String String BackupPath Specifies the path on the remote host for saving the backup file. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Set-LmBackupConfiguration -BackupEnable yes Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Data field...: @{Parameters=} Param........: @{backupenable=yes} backupenable : yes Set-LmBackupSecureIdentity If using scp as the BackupMethod, use this command to upload the remote identity value. Set LmBackupSecureIdentity This is the SSH private key generated using ssh-keygen on the remote scp server. The key file must be encoded in base64 before uploading. Set-LmBackupSecureIdentity Path The path to the private key file, in the format <Path>\<Filename.Extension>, for example C:\t\PrivateKeyExample.ppk. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Set-LmBackupSecureIdentity Path The path to the private key file, in the format <Path>\<Filename.Extension>, for example C:\t\PrivateKeyExample.ppk. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String Path The path to the private key file, in the format <Path>\<Filename.Extension>, for example C:\t\PrivateKeyExample.ppk. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Set-LmBackupSecureIdentity -Path C:\t\PrivateKeyExample.ppk Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Set-LmDateTimeConfiguration Allows you to set the values of the Date and Time options. Set LmDateTimeConfiguration Allows you to set the values of the Date and Time options. Set-LmDateTimeConfiguration NTPHost Specifies the time synchronization server. Multiple hosts can be specified using a space-separated list. String TimeZone Specifies the time zone of the LoadMaster. Valid values are timezones, for example: Etc/UTC GMT CET US/Central US/Eastern Europe/Rome String NTPKeyId The NTP key ID. Valid values range from 1 to 99. Int32 NTPKeySecret The NTP shared secret string. The NTP secret can be a maximum of 40 characters long. If the secret is more than 20 characters long, it is treated as a hex string. Setting this value to an empty string will disable the NTPv4 feature. String NTPKeyType Specify the NTP Key Type. The valid values are SHA-1 and MD5. Note that the values are case sensitive and must be in uppercase. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Set-LmDateTimeConfiguration NTPHost Specifies the time synchronization server. Multiple hosts can be specified using a space-separated list. String TimeZone Specifies the time zone of the LoadMaster. Valid values are timezones, for example: Etc/UTC GMT CET US/Central US/Eastern Europe/Rome String NTPKeyId The NTP key ID. Valid values range from 1 to 99. Int32 NTPKeySecret The NTP shared secret string. The NTP secret can be a maximum of 40 characters long. If the secret is more than 20 characters long, it is treated as a hex string. Setting this value to an empty string will disable the NTPv4 feature. String NTPKeyType Specify the NTP Key Type. The valid values are SHA-1 and MD5. Note that the values are case sensitive and must be in uppercase. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String NTPHost Specifies the time synchronization server. Multiple hosts can be specified using a space-separated list. String String TimeZone Specifies the time zone of the LoadMaster. Valid values are timezones, for example: Etc/UTC GMT CET US/Central US/Eastern Europe/Rome String String NTPKeyId The NTP key ID. Valid values range from 1 to 99. Int32 Int32 NTPKeySecret The NTP shared secret string. The NTP secret can be a maximum of 40 characters long. If the secret is more than 20 characters long, it is treated as a hex string. Setting this value to an empty string will disable the NTPv4 feature. String String NTPKeyType Specify the NTP Key Type. The valid values are SHA-1 and MD5. Note that the values are case sensitive and must be in uppercase. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String This is a legacy command and cannot be used to set all of the available parameters. Please refer to the Get-Help of the Set-Parameter command to view a full list of parameters that can be configured. -------------------------- Example -------------------------- PS C:\> Set-LmDateTimeConfiguration -NTPHost 128.192.150.11 -TimeZone WET Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed; Data=} Return Code..: 200 Response.....: Command successfully executed Data field...: @{DateTimeConfiguration=} Param........: @{NTPHost=128.192.150.11; Time=Thu, 20 Apr 17 12:21:06 WEST; BootTime=Thu, 20 Apr 17 12:02:28 WEST; ActiveTime=Thu, 20 Apr 17 12:02:28 WE ST; TimeZone=WET; NTPKeyId=0} Set-LmDebugConfiguration Allows to set some of the values of options contained in the in the Debug Option screen of the WUI. Set LmDebugConfiguration Allows to set some of the values of options contained in the in the Debug Option screen of the WUI. Set-LmDebugConfiguration irqbalance The purpose of IRQBalance is distribute hardware interrupts across processors on a multiprocessor system. This should only be enabled after consultation with KEMP technical support. Boolean linearesplogs By default, the LoadMaster deletes older log files. If this parameter is enabled, older log files will no longer be deleted. If the filesystem fills up, further access via the LoadMaster is blocked. Boolean netconsole Netconsole is a kernel module which logs kernel printk messages over UDP allowing debugging of problems where disk logging fails. If directed by a KEMP support engineer, the syslog daemon on a specific host will receive all critical kernel messages. This can help in understanding why a LoadMaster is rebooting. Netconsole is mainly used for capturing kernel panic output. To unset this, set the value to an empty string. String netconsoleinterface The interface which hosts the Netconsole. Int16 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Set-LmDebugConfiguration irqbalance The purpose of IRQBalance is distribute hardware interrupts across processors on a multiprocessor system. This should only be enabled after consultation with KEMP technical support. Boolean linearesplogs By default, the LoadMaster deletes older log files. If this parameter is enabled, older log files will no longer be deleted. If the filesystem fills up, further access via the LoadMaster is blocked. Boolean netconsole Netconsole is a kernel module which logs kernel printk messages over UDP allowing debugging of problems where disk logging fails. If directed by a KEMP support engineer, the syslog daemon on a specific host will receive all critical kernel messages. This can help in understanding why a LoadMaster is rebooting. Netconsole is mainly used for capturing kernel panic output. To unset this, set the value to an empty string. String netconsoleinterface The interface which hosts the Netconsole. Int16 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String irqbalance The purpose of IRQBalance is distribute hardware interrupts across processors on a multiprocessor system. This should only be enabled after consultation with KEMP technical support. Boolean Boolean linearesplogs By default, the LoadMaster deletes older log files. If this parameter is enabled, older log files will no longer be deleted. If the filesystem fills up, further access via the LoadMaster is blocked. Boolean Boolean netconsole Netconsole is a kernel module which logs kernel printk messages over UDP allowing debugging of problems where disk logging fails. If directed by a KEMP support engineer, the syslog daemon on a specific host will receive all critical kernel messages. This can help in understanding why a LoadMaster is rebooting. Netconsole is mainly used for capturing kernel panic output. To unset this, set the value to an empty string. String String netconsoleinterface The interface which hosts the Netconsole. Int16 Int16 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Set-LmDebugConfiguration -irqbalance 1 Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Data field...: @{Parameters=} irqbalance : yes Set-LmHAConfiguration Allows you to set the values of High Availability (HA) options. Set LmHAConfiguration Configure the HA options. Set-LmHAConfiguration hatimeout The time the master must be unavailable before a switchover occurs. The valid predetermined time intervals are listed below (in seconds): 3 6 9 12 15 Int16 hawait This is how long (in seconds) after the initial boot, before the LoadMaster becomes active. If the partner machine is running this value is ignored. This value can be changed to mitigate the time taken for some intelligent switches to detect that the LoadMaster has started and to bring up the link. Int16 havhid When using multiple HA LoadMasters on the same network, this value identifies each cluster so that there are no potential unwanted interactions. Int16 haprefered By default, neither partner in a HA cluster has priority. When a machine restarts after a switchover that machine becomes a slave. Specifying a preferred host means that when this machine restarts it will always become the master and the partner will revert to slave mode. String haif The network interface used when synchronising the configuration between the members of the HA cluster. Int16 hal4update When using L4 services, enabling updates allows L4 connection maintenance across a HA switchover. This option is ignored for L7 services. Valid values: 0 - Disabled 1 - Enabled Boolean hal7update When using L7 services, enabling this option allows sharing of persistency information between HA partners. If a HA switchover occurs, the persistency information will then not be lost. Enabling this option can have a significant performance impact. Valid values: 0 - Disabled 1 - Enabled Boolean MCast The network interface used for multicast traffic which is used to synchronize Layer 4 and Layer 7 traffic when Inter HA Updates are enabled. Int16 Vmac This option creates a shared MAC address for both units. When failover occurs, the LoadMaster handles the MAC address handover too. This allows the switches to keep the MAC address and not worry about ARP caches or stale records. Boolean LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Set-LmHAConfiguration hatimeout The time the master must be unavailable before a switchover occurs. The valid predetermined time intervals are listed below (in seconds): 3 6 9 12 15 Int16 hawait This is how long (in seconds) after the initial boot, before the LoadMaster becomes active. If the partner machine is running this value is ignored. This value can be changed to mitigate the time taken for some intelligent switches to detect that the LoadMaster has started and to bring up the link. Int16 havhid When using multiple HA LoadMasters on the same network, this value identifies each cluster so that there are no potential unwanted interactions. Int16 haprefered By default, neither partner in a HA cluster has priority. When a machine restarts after a switchover that machine becomes a slave. Specifying a preferred host means that when this machine restarts it will always become the master and the partner will revert to slave mode. String haif The network interface used when synchronising the configuration between the members of the HA cluster. Int16 hal4update When using L4 services, enabling updates allows L4 connection maintenance across a HA switchover. This option is ignored for L7 services. Valid values: 0 - Disabled 1 - Enabled Boolean hal7update When using L7 services, enabling this option allows sharing of persistency information between HA partners. If a HA switchover occurs, the persistency information will then not be lost. Enabling this option can have a significant performance impact. Valid values: 0 - Disabled 1 - Enabled Boolean MCast The network interface used for multicast traffic which is used to synchronize Layer 4 and Layer 7 traffic when Inter HA Updates are enabled. Int16 Vmac This option creates a shared MAC address for both units. When failover occurs, the LoadMaster handles the MAC address handover too. This allows the switches to keep the MAC address and not worry about ARP caches or stale records. Boolean LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String hatimeout The time the master must be unavailable before a switchover occurs. The valid predetermined time intervals are listed below (in seconds): 3 6 9 12 15 Int16 Int16 hawait This is how long (in seconds) after the initial boot, before the LoadMaster becomes active. If the partner machine is running this value is ignored. This value can be changed to mitigate the time taken for some intelligent switches to detect that the LoadMaster has started and to bring up the link. Int16 Int16 havhid When using multiple HA LoadMasters on the same network, this value identifies each cluster so that there are no potential unwanted interactions. Int16 Int16 haprefered By default, neither partner in a HA cluster has priority. When a machine restarts after a switchover that machine becomes a slave. Specifying a preferred host means that when this machine restarts it will always become the master and the partner will revert to slave mode. String String haif The network interface used when synchronising the configuration between the members of the HA cluster. Int16 Int16 hal4update When using L4 services, enabling updates allows L4 connection maintenance across a HA switchover. This option is ignored for L7 services. Valid values: 0 - Disabled 1 - Enabled Boolean Boolean hal7update When using L7 services, enabling this option allows sharing of persistency information between HA partners. If a HA switchover occurs, the persistency information will then not be lost. Enabling this option can have a significant performance impact. Valid values: 0 - Disabled 1 - Enabled Boolean Boolean MCast The network interface used for multicast traffic which is used to synchronize Layer 4 and Layer 7 traffic when Inter HA Updates are enabled. Int16 Int16 Vmac This option creates a shared MAC address for both units. When failover occurs, the LoadMaster handles the MAC address handover too. This allows the switches to keep the MAC address and not worry about ARP caches or stale records. Boolean Boolean LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String To get the HA status, run the following command: Get-LmParameter -Param HAStatus To enable HA checking on an interface, run the following command: Set-NetworkInterface -HACheck <InterfaceID> -------------------------- Example -------------------------- PS C:\> Set-LMHAConfiguration -HATimeout 3 Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. hatimeout : 3 Set-LmHAMode Set the High Availability (HA) mode. Set LmHAMode Set the HA mode. Set-LmHAMode HaMode The HA mode can be one of the following options: SingleMode - Non-HA mode First - HA 1 mode Second - HA 2 mode String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Set-LmHAMode HaMode The HA mode can be one of the following options: SingleMode - Non-HA mode First - HA 1 mode Second - HA 2 mode String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String HaMode The HA mode can be one of the following options: SingleMode - Non-HA mode First - HA 1 mode Second - HA 2 mode String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Set-LmHAMode -HaMode SingleMode Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Set-LmParameter A large number of LoadMaster parameters can be configured using the Set-LmParameter command. Set LmParameter Below is a list of the parameters that can be configured using the Set-LmParameter command. The parameters are grouped and ordered by WUI section. ----------------- WUI Section: Home ----------------- version Retrieves the LoadMaster firmware version. serialnumber The serial number of the LoadMaster. boottime The time at which the LoadMaster last booted. activetime When using non-HA mode, the activetime is the same as the boottime. When in HA mode, the active time is the time at which the LoadMaster last became the master unit. The active time will be zero if the LoadMaster is in slave mode. -------------------------------------------------------------------------- WUI Section: Virtual Services > View/Modify Services > Advanced Properties -------------------------------------------------------------------------- addvia Specifies which headers should be added to the HTTP stream. The parameter takes the following arguments: 0 = Legacy Operation 1 = X-Forwarded-For 2 = None 3 = X-Client-Side 4 = X-Client-Side No Via 5 = X-Forwarded-For No Via 6 = Via Only ------------------------------------ WUI Section: Certificates & Security ------------------------------------ localcert This parameter is only relevant when using HA. ------------------------------------------------------- WUI Section: Certificates & Security > SSL Certificates ------------------------------------------------------- admincert The certificate used, if any, for the administrative interface. ---------------------------------------------------- WUI Section: Certificates & Security > Remote Access ---------------------------------------------------- admingw When administering the LoadMaster from a non-default interface, this option allows the user to specify a different default gateway for administrative traffic only. sshaccess Specify over which addresses remote administrative SSH access to the LoadMaster is allowed. sshport Specify the port used to access the LoadMaster via the SSH protocol. wuiaccess Enables or disables access to the Web User Interface (WUI). wuiiface Specifies the interface for the WUI. wuiport Specifies the port to access the WUI. sshiface Specify the addresses over which remote administrative SSH access to the LoadMaster is allowed. enableapi Enables the programmable command API Interface. Note: If this is disabled, the API will no longer be accessible. adminclientaccess Valid values for this parameter are: 0 – Password only access (default) 1 – Password or client certificate 2 – Client certificate required 3 – Client certificate required (verify via OCSP) This parameter is only relevant if Session Management is enabled. For further information on Session Management and on the Admin Client Access option, refer to the User Management, Feature Description on the KEMP documentation page: www.kemptechnologies.com/documentation tethering Allow the LoadMaster to regularly check the KEMP website for new software versions. 0 - Disabled 1 - Enabled geoclients Set the addresses of the GEO LoadMasters which can retrieve service status information from the LoadMaster. geopartners Set the IP address of the GEO LoadMaster partner(s). These GEO LoadMasters will keep their DNS configurations in sync. Note: Before partnering GEO LoadMasters, a backup should be taken of the relevant GEO LoadMaster which has the correct/preferred configuration. This backup should then be restored to the other LoadMasters that will be partnered with the original LoadMaster. multihomedwui Allow WUI access from multiple interfaces. Apart from the main administrative interface, each interface can then be enabled to allow WUI access. SSHPreAuth Set the SSH pre-authentication banner, which is displayed before the login prompt when logging in via SSH. Space characters should be escaped by entering %20. This field accepts up to 5,000 characters. Anything past the 5,000 character limit will not be displayed. sessioncac If this parameter is enabled, the LoadMaster will also check for a Common Access Card (CAC) certificate when a user is logging on to the WUI. 0 - Disabled 1 - Enabled -------------------------------------------------------------------------------- WUI Section: Certificates & Security > Remote Access > WUI Authorization Options -------------------------------------------------------------------------------- sessionauthmode Specifies the authentication mode for the LoadMaster. Refer to the following table for values: | RADIUS | LDAP | Local Value | Authent. Author. | Authent. | Authent. Author. 7 | No No | No | No No 263 | Yes No | No | Yes Yes 775 | Yes Yes | No | Yes Yes 23 | No No | Yes | Yes Yes 22 | No No | Yes | No Yes 788 | Yes Yes | Yes | No No 790 | Yes Yes | Yes | No Yes 791 | Yes Yes | Yes | Yes Yes 789 | Yes Yes | Yes | Yes No 773 | Yes Yes | No | Yes No 262 | Yes No | No | No Yes 774 | Yes Yes | No | No Yes 772 | Yes Yes | No | No No 278 | Yes No | Yes | No No 279 | Yes No | Yes | Yes Yes sessionlocalauth Enables or disables local authentication. radiusbackupport Specifies the TCP port for the backup RADIUS server. radiusbackupsecret Specifies the password (secret) to the backup RADIUS server. radiusbackupserver Specifies the backup RADIUS server to use for authentication. radiusport Specifies the TCP port for communication to the RADIUS server. radiussecret Specifies the password (secret) to the RADIUS server. radiusserver Specifies the RADIUS server to use for authentication. radiusrevalidateinterval Specifies when to revalidate the authentication to the RADIUS server. ldapserver Specifies the LDAP server to use for authentication. ldapbackupserver Specifies the backup LDAP server for authentication. ldapsecurity Specifies the security mode for LDAP authentication. ldaprevalidateinterval Specifies how often to revalidate the authentication to the LDAP server. ------------------------------------------------------- WUI Section: Certificates & Security > Admin WUI Access ------------------------------------------------------- sessionidletime Specifies the number of seconds that the WUI can be idle before logging the user out. This can be set from 60 to 86400 seconds. sessionmaxfailattempts Number of failed attempts before locking the user account. This can be set from 1 to 999. sessioncontrol Enables or disables session control. sessionbasicauth If the SessionControl and SessionBasicAuth parameters are both enabled, there are two levels of authentication enforced in order to access the LoadMaster WUI. The initial level is Basic Authentication where users log in using the bal or user logins, which are default usernames defined by the system. sessionconcurrent Limit the maximum number of concurrent connections a single user can have. Range: 0 to 9. A value of 0, means logins are unlimited. geosshport The port over which GEO LoadMasters will communicate with on another. WUIPreAuth Set the pre-authentication click through banner which will be displayed before the LoadMaster login page. This parameter can contain plain text or HTML code. The field cannot contain JavaScript. This field accepts up to 5,000 characters. Anything past the 5,000 character limit will not be displayed. WUITLSProtocols Specify whether or not it is possible to connect to the LoadMaster WUI using the following protocols; SSLv3, TLS1.0, TLS1.1 or TLS1.2. The protocols can be enabled and disabled using a bitmask value in the range 0 to 14. Refer to the table below to find out what number corresponds to which settings. Number | SSLv3 | TLS1.0 | TLS1.1 | TLS1.2 0 | Enabled | Enabled | Enabled | Enabled 1 | Disabled | Enabled | Enabled | Enabled 2 | Enabled | Disabled | Enabled | Enabled 3 | Disabled | Disabled | Enabled | Enabled 4 | Enabled | Enabled | Disabled | Enabled 5 | Disabled | Enabled | Disabled | Enabled 6 | Enabled | Disabled | Disabled | Enabled 7 | Disabled | Disabled | Disabled | Enabled 8 | Enabled | Enabled | Enabled | Disabled 9 | Disabled | Enabled | Enabled | Disabled 10 | Enabled | Disabled | Enabled | Disabled 11 | Disabled | Disabled | Enabled | Disabled 12 | Enabled | Enabled | Disabled | Disabled 13 | Disabled | Enabled | Disabled | Disabled 14 | Enabled | Disabled | Disabled | Disabled WUICipherset Specify the cipher set to use for the LoadMaster WUI. The valid values are below: - Default - Default_NoRc4 - BestPractices - Intermediate_compatibility - Backward_compatibility - WUI - FIPS - Legacy - <NameOfCustomCipherSet> Specify the cipher set to use for the LoadMaster WUI. --------------------------------------------------------- WUI Section: Certificates & Security > OCSP Configuration --------------------------------------------------------- OCSPPort The port of the OCSP server. OCSPUseSSL Specify whether or not to use SSL to connect to the OCSP server. OCSPOnServerFail Treat an OCSP server connection failure of timeout as if the OCSP server had returned a valid response, i.e. treat the client certificate as valid. OCSPServer The address of the OCSP server. OCSPUrl The URL to access on the OCSP server. SSLStapling Enable this parameter to enable the LoadMaster to respond to OCSP stapling requests. If a client connects using SSL and asks for an OCSP response, this is returned. Only Virtual Service certificates are validated. The system holds a cache of OCSP responses that are sent back to the client. This cache is maintained by the OCSP daemon. When the OCSP daemon sends a request to the server, it uses the name specified in the certificate (in the Authority Information Access field). If it cannot resolve this name, then it uses the default OCSP server specified in the OCSPServer parameter. SSHRefreshInterval Specify how often the LoadMaster should refresh the OCSP stapling information. The OCSP daemon caches the entry for up to the amount of time specified here, after which it is refreshed. Valid values range from 3600 (1 hour (default)) to 604800 seconds (7 days). -------------------------------------------------------------- WUI Section: System Configuration > Network Setup > Interfaces -------------------------------------------------------------- mcast The network interface used for multicast traffic which is used to synchronize Layer 4 and Layer 7 traffic when Inter HA Updates are enabled. ---------------------------------------------------------------------------- WUI Section: System Configuration > Network Setup > Host & DNS Configuration ---------------------------------------------------------------------------- dnssecclient Enable or disable DNSSEC client capabilities on the LoadMaster. At least one name server must be configured before DNSSEC can be enabled. After changing this setting, the LoadMaster must be rebooted for the change to be applied. Once the setting is changed, it cannot be changed again until the LoadMaster has been rebooted. If using HA, please set the parameter on both devices separately. 0 = Disabled 1 = Enabled DNSNamesEnable When this option is enabled, the LoadMaster automatically attempts to update any changed DNS names (based on the update interval): - If the address is not found, or if it is the same as before – nothing is done (except a log entry is generated). - If the address is different, the Real Server entry is updated with the new address, if possible. - If the new address is invalid for some reason, for example if it is a non-local address and the nonlocalrs option is disabled, no changes are made and a log is generated. dnsupdateinterval Set the update interval for DNS entries. Valid values range from 1-60 (minutes). The default value is 60. dnsreloadonerror If this parameter is enabled, DNS entries are reloaded when health checks have errors and an FQDN is associated with the Real Server IP address. namserver The DNS server the LoadMaster will use for name resolution. Setting this parameter to an empty string will delete the name servers. The last remaining name server cannot be deleted if the dnssecclient parameter is enabled. This parameter has been deprecated and replaced with the nameserver parameter. nameserver The DNS server the LoadMaster will use for name resolution. Setting this parameter to an empty string will delete the name servers. The last remaining name server cannot be deleted if the dnssecclient parameter is enabled. ha1hostname When using the LoadMaster in HA mode, this is the host name of the first node. If the LoadMaster is not in HA mode, then this will return an error. ha2hostname When using the LoadMaster in HA mode, this is the host name of the second node. If the LoadMaster is not in HA mode, then this will return an error. hostname The hostname assigned to the LoadMaster. searchlist The domain suffix search list when performing DNS resolution. ------------------------------------------------------------------- WUI Section: System Configuration > Network Setup > Default Gateway ------------------------------------------------------------------- dfltgw Specify the IPv4 default gateway that is to be used for communicating with the internet. dfltgwv6 Specify the IPv6 default gateway that is to be used for communicating with the internet. -------------------------------------------------------------------------- WUI Section: System Configuration > System Administration > Backup/Restore -------------------------------------------------------------------------- backupday For scheduled backups, this parameter specifies the "day" number (0-7). backupenable Specifies if scheduled backups are enabled. backuphost Specifies the host to save the backup file to. backuphour For scheduled backups, this parameter specifies the "hour" number (0-23). backupminute For scheduled backups, this parameter specifies the "minute" number (0-59). backupsecure Specify the file transfer method for automated backups. 0 – Ftp (insecure) 1 – scp (secure) backuppassword Specifies the password for the user account that has access to save the backup file. backuppath Specifies the path on the remote host for saving the backup file. backupuser Specifies the user account that has access to save the backup file. --------------------------------------------------------------------- WUI Section: System Configuration > System Administration > Date/Time --------------------------------------------------------------------- ntphost Specifies the time synchronization server. Multiple hosts can be specified using a space-separated list. ntpkeytype Specify the NTP Key Type. The valid values are SHA-1 (SHA) and MD5 (M). The values must be specified in uppercase. ntpkeysecret The NTP shared secret string. The NTP secret can be a maximum of 40 characters long. If the secret is more than 20 characters long, it is treated as a hex string. Setting this value to an empty string will disable the NTPv4 feature. ntpkeyid The NTP key ID. Valid values range from 1 to 99. timezone Specifies the time zone of the LoadMaster. time Sets the time of the LoadMaster. ------------------------------------------------------------------- WUI Section: System Configuration > Logging Options > Debug Options ------------------------------------------------------------------- irqbalance The purpose of IRQBalance is distribute hardware interrupts across processors on a multiprocessor system. This should only be enabled after consultation with KEMP Technical Support. backupnetstat By default, the LoadMaster includes a Netstat output in backups taken. When this is included, backups take longer to complete. You can stop the Netstat output from being included by disabling this parameter. linearesplogs By default, the LoadMaster deletes older log files. If this parameter is enabled, older log files will no longer be deleted. If the filesystem fills up, further access via the LoadMaster is blocked. netconsole Netconsole is a kernel module which logs kernel printk messages over UDP allowing debugging of problems where disk logging fails. If directed by a KEMP support engineer, the syslog daemon on a specific host will receive all critical kernel messages. This can help in understanding why a LoadMaster is rebooting. netconsoleinterface The interface which hosts the Netconsole. -------------------------------------------------------------------- WUI Section: System Configuration > Logging Options > Syslog Options -------------------------------------------------------------------- syslogemergency Use this option to set the host(s) which will receive Emergency events only. Entries must be comma-separated. Up to 10 entries are supported in total for all levels. syslogcritical Use this option to set the host(s) which will receive Emergency and Critical events. Entries must be comma-separated. Up to 10 entries are supported in total for all levels. syslogerror Use this option to set the host(s) which will receive Emergency, Critical and Error events. Entries must be comma-separated. Up to 10 entries are supported in total for all levels. sysloginfo Use this option to set the host(s) which will receive Emergency, Critical, Error and Warning events. Entries must be comma-separated. Up to 10 entries are supported in total for all levels. syslognotice Use this option to set the host(s) which will receive Emergency, Critical, Error, Warning and Notice events. Entries must be comma-separated. Up to 10 entries are supported in total for all levels. syslogwarn Use this option to set the host(s) which will receive All events. Entries must be comma-separated. Up to 10 entries are supported in total for all levels. syslogport Specify the port that syslog messages are sent to on the receiving hosts. ------------------------------------------------------------------ WUI Section: System Configuration > Logging Options > SNMP Options ------------------------------------------------------------------ snmpenable Enable or disable SNMP. snmpV3enable Enable SNMP V3. 0 = Disabled 1 = Enabled snmpv3user Specify the username. snmpv3userpasswd Specify the user password. snmpAuthProt Specify the relevant authentication protocol: - MD5 - SHA SHA is a more secure protocol. snmpPrivProt Specify the relevant privacy protocol: - DES - AES AES is a more secure protocol. snmpcontact Specify the contact address that is sent in SNMP responses. snmpcommunity Specify the SNMP community string. snmplocation Specify the location that is sent in SNMP responses. snmpHaTrap Send SNMP traps from the shared IP address. This option is only available when the LoadMaster is in HA mode. snmpv1sink Specify the sink address for SNMP type 1 traps. snmpv2sink Specify the sink address for SNMP type 2 traps. snmpclient Specify the list of machines that can access the SNMP subsystem. If no clients are specified, then anyone can access SNMP. snmptrapenable Enable the generation of SNMP events whenever a significant event occurs. ------------------------------------------------------------------- WUI Section: System Configuration > Logging Options > Email Options ------------------------------------------------------------------- emailuser The user account with access to send mail messages. emaildomain The domain, if required, for the user account authentication. emailpassword The email user's password. emailserver The host name or address of the SMTP server to send mail messages through. emailsslmode Specify the type of security protocol that should be used on the connection: 0 = None 1 = STARTTLS, if available 2 = STARTTLS 3 = SSL/TLS emailport The TCP port on which your mail server accepts connections (usually 25). emailcritical The email address to receive critical messages. emailemergency The email address to receive emergency messages. emailerror The email address to receive error messages. emailinfo The email address to receive informational messages. emailnotice The email address to receive notices. emailwarn The email address to receive warnings. emailenable Enables or disables the email logging options. ------------------------------------------------------------------- WUI Section: System Configuration > Logging Options > SDN Log Files ------------------------------------------------------------------- sdnstatsmode There are two modes that can be used to gather the SDN statistics. The modes are described below: • Mode 1: When set to mode 1, the statistics are taken from the switch port that is connected to the server and the statistics are relayed back to the LoadMaster. • Mode 2: When set to mode 2, the information is taken from all of the switch ports along the path. ------------------------------------------------------------------------ WUI Section: System Configuration > Miscellaneous Options > WUI Settings ------------------------------------------------------------------------ hoverhelp Enables or disables hover help in the WUI. motd Sets the Message Of The Day (MOTD) for the web user interface. Either plain text or a text file can be used. The maximum number of characters is 5,000. An error will be displayed if the MOTD is greater than 5,000 characters. wuidisplaylines Specifies the number of display lines in the WUI. This can be set from 10 to 100. ---------------------------------------------------------------------------- WUI Section: System Configuration > Miscellaneous Options > L7 Configuration ---------------------------------------------------------------------------- transparent When using Layer 7, when this is enabled the connection arriving at the Real Server appears to come directly from the client. Alternatively, the connection can be non-transparent which means that the connections at the Real Server appear to come from the LoadMaster. alwayspersist This parameter also accepts no and yes as valid values. No and Yes correspond to 0 and 1 respectively. expect100 By default, the L7 module only waits for 100-Continue replies if it sees an Expect-100 header, use RFC-2616 Compliant. If the system will always wait for 100 Continue messages, use Require 100-Continue. If the client will always send the POST data even if a 100 Continue message is not sent, use RFC-7231 Compliant instead. localbind In very high load situations, local port exhaustion can occur. Enabling this option allows the setting of alternate source addresses. This can be used to expand the number of available local ports. addcookieport When using the LoadMaster behind a NATing gateway, all client addresses are the same. To create individual cookies the remote port can also be added to the cookie. Enabling this option when not needed wastes resources. addforwardheader This option, only available when L7 Transparency is disabled, allows the addition of either X-ClientSide or X-Forwarded For to the HTTP header. authtimeout The duration (in seconds) that a connection remains open for while authentication is ongoing. This value can be between 30 and 300. clienttokentimeout The duration (in seconds) to wait for the client token while the process of authentication is ongoing (used for RSA SecurID and RADIUS authentication). The default value for this parameter is 120. finalpersist When a Real Server is disabled, the sessions persisting on that Real Server continue to be served until the Drain Time has expired or until no more sessions are being handled by the Real Server. No new sessions will be handled by the Real Server. Valid values include 0, and 60 to 86400. rfcconform By default, the LoadMaster conforms to the RFC when parsing HTTP headers. Disabling this will allow interworking with some broken browsers. dropatdrainend If enabled, all open connections to disabled Real Servers will be dropped at the end of the Real Servers Drain Stop Time or immediately if there are no Persist entries associated with the Real Server. droponfail By default, existing connections are not closed if a Real Server fails. Enabling this feature causes all connections to be immediately dropped on Real Server failure. closeonerror When enabled, the LoadMaster will always close the client connection when it sends back an error response. For Example, this changes the behaviour of the LoadMaster when sending back a 304 File not changed message after receiving an If-Modified-Since HTTP header. rsarelocal When checking to see if a client is on the local subnet, also check to see if the client is actually a Real Server. slowstart When using the Least Connection (or Weighted Least Connection) scheduling method, specify the time (in seconds) over which the load to a Real Server which has just come online will be throttled. ShareSubVSPersist By default, each SubVS has an independent persistence table. Enabling this parameter will allow the SubVS to share this information. logsplitinterval When using Log Insight Scheduling this is the number of messages which are received on a connection before the stream is rescheduled. The default value is 10. allowemptyposts By default the LoadMaster blocks POSTs that do not contain a Content-Length or Transfer-Encoding header to indicate the length of the requests payload. When this parameter is set to true, such requests are assumed to have no payload data and are therefore not rejected. forcefullrsmatch By default, when the LoadMaster is trying to locate a Real Server for use with content switching, it tries to use the same Real Server as currently selected, even if the port is not the same. If this parameter is enabled - the port is also compared. AllowEmptyHttpHeaders By default, if the LoadMaster is processing HTTP headers, it will ignore HTTP headers that have empty content. This can break some SOAP Services even though it is against the HTTP RFCs. Enabling this option will allow these empty headers through. loguseragent When enabled, the User Agent header field is added to the User Logs. 0 - Disabled 1 - Enabled --------------------------------------------------------------------------- WUI Section: System Configuration > Miscellaneous Options > Network Options --------------------------------------------------------------------------- snat Enabling this options allows the LoadMaster to NAT connections from the Real Servers to the internet. routefilter When enabled, this option only accepts IP frames from a host over the interface where the routing algorithm would route frames to the host. This is known as strict source route validation. subnetoriginating When transparency is disabled for a Virtual Service, the source IP address of connections to Real Servers is the Virtual Service. When enabled, the source IP address is the local address of the LoadMaster. If the Real Server is on a subnet, the subnet address of the LoadMaster will be used. nonlocalrs Enable this option to allow assigning non-local Real Servers to Virtual Services. multigw Use this option to enable the ability to move the default gateway to a different interface. conntimeout Specify the timeout value for the check request. Range: 4-60 tcptimestamp The LoadMaster can include a timestamp in the SYN when connecting to Real Servers. Only enable this option when requested to from KEMP Support. resetclose When enabled, the LoadMaster will close its connection to the Real Servers by using TCP RESET instead of the normal close handshake. keepalive By default, the system uses TCP keepalives to check for failed clients. Enabling this option improves the reliability of older TCP connections (SSH sessions). Not normally required for normal HTTP/HTTPS services. allowupload The LoadMaster has been optimized with HTTP workloads in mind. Enabling this option allows non HTTP uploads to work correctly. subnetorigin When transparency is disabled for a Virtual Service, the source IP address of connections to Real Servers is the Virtual Service. When enabled, the source IP address is the local address of the LoadMaster. If the Real Server is on a subnet, the subnet address of the LoadMaster will be used. onlydefaultroutes Enable this option to force traffic from Virtual Services, which have default route entries set, to be routed to the interface where the Virtual Service’s default route is located. http_proxy This option allows clients to specify the HTTP(S) proxy server and port the LoadMaster will use to access the internet. dhkeysize Select the strength of the key used in the Diffe-Hellman key exchanges. If this value is changed, a reboot is required in order to use the new value. The default value is 2048 Bits. sslrenegotiate By default, the LoadMaster allows a client to automatically renegotiate during an SSL transaction. Disabling this parameter causes SSL connections to terminate if a renegotiation is requested by the client. sslforceserververify By default, when re-encrypting traffic the LoadMaster does not check the certificate provided by the Real Server. Enabling this option forces the LoadMaster to verify that the certificate on the Real Server is valid, that is, the certificate authority and expiration are OK. This includes all intermediate certificates. tcpnorecycle Enable this option to revert to the legacy mode of reusing TCP timewait connections. Note: Only enable this after consulting with KEMP Support. ----------------------------------------------------------------------------- WUI Section: System Configuration > Miscellaneous Options > AFE Configuration ----------------------------------------------------------------------------- paranoia Sets the sensitivity of IDS detection. cachesize Specifies the cache size. hostcache Enable or disable using the host cache. limitinput Limit the number of connections. L7LimitInput This setting limits the default maximum number of connection attempts (per second) from a specific host. ------------------------------------------------------------------------- WUI Section: System Configuration > Miscellaneous Options > HA Parameters ------------------------------------------------------------------------- hastatus The status of a HA or cluster unit. This is a read only parameter and cannot be set. Possible values are: Normal HA: Active, Standby, Passive (all as expected). Cloud HA: Active, Standby, Passive (if status not yet set). Cluster: Active (if master), Standby (if slave), Passive (if disabled). hatimeout The time the master must be unavailable before a switchover occurs. Allowed Values: 1-5, each option being a predetermined time interval: 1 = 3 seconds 2 = 6 seconds 3 = 9 seconds 4 = 12 seconds 5 = 15 seconds hawait This is how long (in seconds) after the initial boot, before the LoadMaster becomes active. If the partner machine is running this value is ignored. This value can be changed to mitigate the time taken for some intelligent switches to detect that the LoadMaster has started and to bring up the link. haprefered By default, neither partner in a HA cluster has priority. When a machine restarts after a switchover that machine becomes a slave. Specifying a preferred host means that when this machine restarts it will always become the master and the partner will revert to slave mode. hamode Specify the HA mode. If only using a single LoadMaster, use Non-HA Mode. In HA mode, one LoadMaster must be specified as the first and another as second. HA will not work if both LoadMasters are specified the same. 0 = Turn off HA mode 1 = HA 1 mode 2 = HA 2 mode haif The network interface used when synchronising the configuration between the members of the HA cluster. havhid When using multiple HA LoadMasters on the same network, this value identifies each cluster so that there are no potential unwanted interactions. hastyle By default, the system uses a version of VRRP (carp) to check the status of the partner. The system can also support the legacy Heartbeat program. This option only takes effect when both machines are rebooted. 0 - legacy heartbeat 1 - carp hainitial Perform extra network checks at boot time. This may cause instability and should not be used. tcpfailover When using L4 services, enabling updates allows L4 connection maintenance across a HA switchover. This option is ignored for L7 services. This parameter is now deprecated and has been replaced with the HAL4update parameter. cookieupdate When using L7 services, enabling this option allows sharing of persistency information between HA partners. If a HA switchover occurs, the persistency information will then not be lost. Enabling this option can have a significant performance impact. This parameter is now deprecated and has been replaced with the HAL7Update parameter. hal4update When using L4 services, enabling updates allows L4 connection maintenance across a HA switchover. This option is ignored for L7 services. hal7update When using L7 services, enabling this option allows sharing of persistency information between HA partners. If a HA switchover occurs, the persistency information will then not be lost. Enabling this option can have a significant performance impact. vmac This option creates a shared MAC address for both units. When failover occurs, the LoadMaster handles the MAC address handover too. This allows the switches to keep the MAC address and not worry about ARP caches or stale records. Set-LmParameter Param The parameter to configure. String Value The value to set the parameter to. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Set-LmParameter Param The parameter to configure. String Value The value to set the parameter to. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String Param The parameter to configure. String String Value The value to set the parameter to. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Set-LmParameter -Param SSLRefreshInterval -Value 4000 Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Set-LmVpnAddrs Allows you to set the Virtual Private Network (VPN) addresses at the same time. Set LmVpnAddrs Use this command to set the VPN addresses, such as the local IP address, local subnet(s), remote IP address and remote subnet(s). Set-LmVpnAddrs Name The name of the VPN. String LocalIp In non-HA mode, the default is the LoadMaster IP address, i.e. the IP address of the default gateway interface. In HA-mode, the default is the shared IP address. String LocalSubnets When the LocalIp is set, the LocalSubnet is automatically populated. Multiple local subnets can be specified using a comma-separated list. Up to 10 IP addresses can be specified. String RemoteIp Set the IP address for the remote side of the connection. String RemoteSubnets Set the subnet for the remote side of the connection. Multiple remote subnets can be specified using a comma-separated list. Up to 10 IP addresses can be specified. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Set-LmVpnAddrs Name The name of the VPN. String LocalIp In non-HA mode, the default is the LoadMaster IP address, i.e. the IP address of the default gateway interface. In HA-mode, the default is the shared IP address. String LocalSubnets When the LocalIp is set, the LocalSubnet is automatically populated. Multiple local subnets can be specified using a comma-separated list. Up to 10 IP addresses can be specified. String RemoteIp Set the IP address for the remote side of the connection. String RemoteSubnets Set the subnet for the remote side of the connection. Multiple remote subnets can be specified using a comma-separated list. Up to 10 IP addresses can be specified. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String Name The name of the VPN. String String LocalIp In non-HA mode, the default is the LoadMaster IP address, i.e. the IP address of the default gateway interface. In HA-mode, the default is the shared IP address. String String LocalSubnets When the LocalIp is set, the LocalSubnet is automatically populated. Multiple local subnets can be specified using a comma-separated list. Up to 10 IP addresses can be specified. String String RemoteIp Set the IP address for the remote side of the connection. String String RemoteSubnets Set the subnet for the remote side of the connection. Multiple remote subnets can be specified using a comma-separated list. Up to 10 IP addresses can be specified. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Set-LmVpnAddrs -LocalIp 10.12.12.15 -LocalSubnets 10.12.12.0 -Name ExampleVpnAddress -RemoteIp 172.22.55.52 -RemoteSubnets 172.22.55.0 Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Set-LmVpnLocalIp Allows you to set the local IP address of a Virtual Private Network (VPN). Set LmVpnLocalIp Use this command to configure the local IP address of the specified VPN. Set-LmVpnLocalIp Name The name of the VPN. String LocalIp In non-HA mode, the default is the LoadMaster IP address, i.e. the IP address of the default gateway interface. In HA-mode, the default is the shared IP address. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Set-LmVpnLocalIp Name The name of the VPN. String LocalIp In non-HA mode, the default is the LoadMaster IP address, i.e. the IP address of the default gateway interface. In HA-mode, the default is the shared IP address. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String Name The name of the VPN. String String LocalIp In non-HA mode, the default is the LoadMaster IP address, i.e. the IP address of the default gateway interface. In HA-mode, the default is the shared IP address. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Set-LmVpnLocalIp -Name ExampleVPN -LocalIp 10.154.11.123 Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Set-LmVpnLocalSubnet Allows you to set the Local Subnet Address(es). Set LmVpnLocalSubnet Use this command to configure the Local Subnet Address(es) of the Virtual Private Network (VPN). Set-LmVpnLocalSubnet Name The name of the VPN. String LocalSubnets When the LocalIp is set, the LocalSubnet is automatically populated. Multiple local subnets can be specified using a comma-separated list. Up to 10 IP addresses can be specified. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Set-LmVpnLocalSubnet Name The name of the VPN. String LocalSubnets When the LocalIp is set, the LocalSubnet is automatically populated. Multiple local subnets can be specified using a comma-separated list. Up to 10 IP addresses can be specified. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String Name The name of the VPN. String String LocalSubnets When the LocalIp is set, the LocalSubnet is automatically populated. Multiple local subnets can be specified using a comma-separated list. Up to 10 IP addresses can be specified. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Set-LmVpnLocalSubnet -LocalSubnets 10.11.11.0 -Name ExampleVpnLocalSubnet Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Set-LmVpnPfsDisable Disable the Perfect Forward Secrecy (PFS) option. Set LmVpnPfsDisable Allows you to disable the PFS option for a particular VPN connection. Set-LmVpnPfsDisable Name The name of the VPN connection. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Set-LmVpnPfsDisable Name The name of the VPN connection. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String Name The name of the VPN connection. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Set-LmVpnPfsDisable -Name ExampleVpn Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Set-LmVpnPfsEnable Enable the Perfect Forward Secrecy (PFS) option. Set LmVpnPfsEnable Allows you to enable the PFS option for a particular VPN connection. Set-LmVpnPfsEnable Name The name of the VPN connection. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Set-LmVpnPfsEnable Name The name of the VPN connection. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String Name The name of the VPN connection. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Set-LmVpnPfsEnable -Name ExampleVpn Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Set-LmVpnRemoteIp Allows you to set the Remote IP Address of the specified Virtual Private Network (VPN). Set LmVpnRemoteIp Set the IP address for the remote side of the connection. Set-LmVpnRemoteIp Name The name of the VPN. String RemoteIp Set the IP address for the remote side of the connection. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Set-LmVpnRemoteIp Name The name of the VPN. String RemoteIp Set the IP address for the remote side of the connection. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String Name The name of the VPN. String String RemoteIp Set the IP address for the remote side of the connection. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Set-LmVpnRemoteIp -Name ExampleVpnRemoteIp -RemoteIp 172.22.55.2 Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Set-LmVpnRemoteSubnet Allows you to set the Remote Subnet Address(es) of the specified Virtual Private Network (VPN). Set LmVpnRemoteSubnet Use this command to configure the Remote Subnet Address(es) of the specified VPN. Set-LmVpnRemoteSubnet Name The name of the VPN. String RemoteSubnets Set the subnet for the remote side of the connection. Multiple remote subnets can be specified using a comma-separated list. Up to 10 IP addresses can be specified. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Set-LmVpnRemoteSubnet Name The name of the VPN. String RemoteSubnets Set the subnet for the remote side of the connection. Multiple remote subnets can be specified using a comma-separated list. Up to 10 IP addresses can be specified. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String Name The name of the VPN. String String RemoteSubnets Set the subnet for the remote side of the connection. Multiple remote subnets can be specified using a comma-separated list. Up to 10 IP addresses can be specified. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Set-LmVpnRemoteSubnet -Name ExampleVpnRemoteSubnet -RemoteSubnets 10.115.2.0 Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Set-LmVpnSecret Allows you to set the connection secret details of the specified Virtual Private Network (VPN). Set LmVpnSecret Configure the connection secret details for the specified VPN. Set-LmVpnSecret Name The name of the VPN. String LocalId Identification for the local side of the connection. String RemoteId Identification for the remote side of the connection. This can be the remoteip. String Key The Pre Shared Key (PSK) string. This is the Shared key which is generated and managed on the Azure side. The key length should be at least 16 and at most 64 characters. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Set-LmVpnSecret Name The name of the VPN. String LocalId Identification for the local side of the connection. String RemoteId Identification for the remote side of the connection. This can be the remoteip. String Key The Pre Shared Key (PSK) string. This is the Shared key which is generated and managed on the Azure side. The key length should be at least 16 and at most 64 characters. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String Name The name of the VPN. String String LocalId Identification for the local side of the connection. String String RemoteId Identification for the remote side of the connection. This can be the remoteip. String String Key The Pre Shared Key (PSK) string. This is the Shared key which is generated and managed on the Azure side. The key length should be at least 16 and at most 64 characters. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Set-LmVpnSecret -Key ExampleKeyExampleKey -LocalId 10.35.47.24 -Name ExampleVPN -RemoteId 10.23.34.33 Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Set-LmWuiSetting Configure the WUI settings. Set LmWuiSetting Use this command to set values for the WUI settings parameters, such as hoverhelp and motd (Message of the Day). Set-LmWuiSetting hoverhelp Enable/disable hover help text in the WUI. 0 - Disable 1 - Enable Boolean motd Set the Message of the Day (MOTD), which is displayed on the WUI home page after logging in. String wuidisplaylines Set the maximum number of lines to be displayed on a single statistics page. Int32 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Set-LmWuiSetting hoverhelp Enable/disable hover help text in the WUI. 0 - Disable 1 - Enable Boolean motd Set the Message of the Day (MOTD), which is displayed on the WUI home page after logging in. String wuidisplaylines Set the maximum number of lines to be displayed on a single statistics page. Int32 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String hoverhelp Enable/disable hover help text in the WUI. 0 - Disable 1 - Enable Boolean Boolean motd Set the Message of the Day (MOTD), which is displayed on the WUI home page after logging in. String String wuidisplaylines Set the maximum number of lines to be displayed on a single statistics page. Int32 Int32 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Set-LmWuiSetting -hoverhelp 0 -motd "Example Message of the Day" Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Data field...: @{Parameters=} Param........: @{motd=Example Message of the Day} Set-LogEmailConfiguration Allows you to set the values of the email logging options. Set LogEmailConfiguration Configure the various levels of email logging recipients. Set-LogEmailConfiguration EmailEnable Enables or disables the email logging options. Boolean EmailServer The host name or address of the SMTP server to send mail messages through. String EmailPort The TCP port on which your mail server accepts connections (usually 25). Int32 EmailUser The user account with access to send mail messages. String EmailPassword The email user's password. String EmailDomain The domain, if required, for the user account authentication. String EmailSSLMode Specify the type of security protocol that should be used on the connection: 0 - None 1 - STARTTLS, if available 2 - STARTTLS 3 - SSL/TLS Int16 EmailEmergency The email address to receive emergency messages. String EmailCritical The email address to receive critical messages. String EmailError The email address to receive error messages. String EmailWarn The email address to receive warnings. String EmailNotice The email address to receive notices. String EmailInfo The email address to receive informational messages. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Set-LogEmailConfiguration EmailEnable Enables or disables the email logging options. Boolean EmailServer The host name or address of the SMTP server to send mail messages through. String EmailPort The TCP port on which your mail server accepts connections (usually 25). Int32 EmailUser The user account with access to send mail messages. String EmailPassword The email user's password. String EmailDomain The domain, if required, for the user account authentication. String EmailSSLMode Specify the type of security protocol that should be used on the connection: 0 - None 1 - STARTTLS, if available 2 - STARTTLS 3 - SSL/TLS Int16 EmailEmergency The email address to receive emergency messages. String EmailCritical The email address to receive critical messages. String EmailError The email address to receive error messages. String EmailWarn The email address to receive warnings. String EmailNotice The email address to receive notices. String EmailInfo The email address to receive informational messages. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String EmailEnable Enables or disables the email logging options. Boolean Boolean EmailServer The host name or address of the SMTP server to send mail messages through. String String EmailPort The TCP port on which your mail server accepts connections (usually 25). Int32 Int32 EmailUser The user account with access to send mail messages. String String EmailPassword The email user's password. String String EmailDomain The domain, if required, for the user account authentication. String String EmailSSLMode Specify the type of security protocol that should be used on the connection: 0 - None 1 - STARTTLS, if available 2 - STARTTLS 3 - SSL/TLS Int16 Int16 EmailEmergency The email address to receive emergency messages. String String EmailCritical The email address to receive critical messages. String String EmailError The email address to receive error messages. String String EmailWarn The email address to receive warnings. String String EmailNotice The email address to receive notices. String String EmailInfo The email address to receive informational messages. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String To unset a parameter, set the parameter to an empty string, for example: Set-LogEmailConfiguration -EmailEmergency "" -------------------------- Example -------------------------- PS C:\> Set-LogEmailConfiguration -EmailCritical criticaluser@kemptechnologies.com -EmailEmergency emergencycontact@kemptechnologies.com Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed; Data=} Return Code..: 200 Response.....: Command successfully executed Data field...: @{EmailConfiguration=} Param........: @{EmailEnable=yes; EmailServer=10.154.22.132; EmailPort=80; EmailUser=test; EmailPassword=********; EmailDomain=ExampleDomain; EmailSSLMo de=1; EmailEmergency=emergencycontact@kemptechnologies.com; EmailCritical=criticaluser@kemptechnologies.com; EmailError=; EmailWarn=; EmailNotice=; Emai lInfo=} EmailEnable : yes EmailServer : 10.154.22.132 EmailPort : 80 EmailUser : test EmailPassword : ******** EmailDomain : ExampleDomain EmailSSLMode : 1 EmailEmergency : emergencycontact@kemptechnologies.com EmailCritical : criticaluser@kemptechnologies.com EmailError : EmailWarn : EmailNotice : EmailInfo : Set-LogSplitInterval WARNING: This function is deprecated. Use the following command instead: Set-AdcL7LogInsightSplitConfiguration Set LogSplitInterval WARNING: This function is deprecated. Use the following command instead: Set-AdcL7LogInsightSplitConfiguration Set-LogSplitInterval logsplitinterval String LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String Set-LogSplitInterval logsplitinterval String LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String logsplitinterval String String LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String Set-LogSyslogConfiguration Allows you set which hosts the various Syslog messages get sent to. Set LogSyslogConfiguration Configure the various levels of syslog level alerts. Set-LogSyslogConfiguration SyslogCritical Specifies the syslog host for critical notifications. String SyslogEmergency Specifies the syslog host for emergency notifications. String SyslogError Specifies the syslog host for error notifications. String SyslogInfo Specifies the syslog host for information notices. String SyslogNotice Specifies the syslog host for general notifications. String SyslogWarn Specifies the syslog host for warning notifications. String SyslogPort Specify a non-standard port for syslog transfer. UInt16 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Set-LogSyslogConfiguration SyslogCritical Specifies the syslog host for critical notifications. String SyslogEmergency Specifies the syslog host for emergency notifications. String SyslogError Specifies the syslog host for error notifications. String SyslogInfo Specifies the syslog host for information notices. String SyslogNotice Specifies the syslog host for general notifications. String SyslogWarn Specifies the syslog host for warning notifications. String SyslogPort Specify a non-standard port for syslog transfer. UInt16 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String SyslogCritical Specifies the syslog host for critical notifications. String String SyslogEmergency Specifies the syslog host for emergency notifications. String String SyslogError Specifies the syslog host for error notifications. String String SyslogInfo Specifies the syslog host for information notices. String String SyslogNotice Specifies the syslog host for general notifications. String String SyslogWarn Specifies the syslog host for warning notifications. String String SyslogPort Specify a non-standard port for syslog transfer. UInt16 UInt16 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String Up to ten individual IP addresses/hostnames can be specified for each of the Syslog fields. Multiple IP addresses/hostnames must be differentiated using a comma-separated list. To unset the configuration for a level, run the command with empty parameter values, for example: Set-LogSyslogConfiguration -SyslogError "" -------------------------- Example -------------------------- PS C:\> Set-LogSyslogConfiguration -SyslogCritical 10.154.11.39 -SyslogEmergency 10.154.11.26 Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed; Data=} Return Code..: 200 Response.....: Command successfully executed Data field...: @{SyslogSettings=} Param........: @{SyslogEmergency=10.154.11.26; SyslogCritical=10.154.11.39; SyslogError=; SyslogWarn=; SyslogNotice=; SyslogInfo=10.154.153.94; SyslogPo rt=60} SyslogEmergency : 10.154.11.26 SyslogCritical : 10.154.11.39 SyslogError : SyslogWarn : SyslogNotice : SyslogInfo : 10.154.153.94 SyslogPort : 60 Set-NetworkConfiguration Allows you to set the values of Networking options. Set NetworkConfiguration Allows you to set the values of Networking options. Set-NetworkConfiguration SNAT Enabling this options allows the LoadMaster to NAT connections from the Real Servers to the internet. Boolean AllowUpload The LoadMaster has been optimized with HTTP workloads in mind. Enabling this option allows non HTTP uploads to work correctly. Boolean ConnTimeout Specify, in seconds, the time a connection can be idle before it is closed. This is independent of Persistency Timeout. Setting a value of 0 resets to the default value of 660 seconds. Int64 KeepAlive By default, the system uses TCP keepalives to check for failed clients. Enabling this option improves the reliability of older TCP connections (SSH sessions). Not normally required for normal HTTP/HTTPS services. Boolean MultiGW Use this option to enable the ability to move the default gateway to a different interface. Boolean NonLocalRS Enable this option to allow assigning non-local Real Servers to Virtual Services. Boolean OnlyDefaultRoutes Enable this option to force traffic from Virtual Services, which have default route entries set, to be routed to the interface where the Virtual Service’s default route is located. Boolean ResetClose When enabled, the LoadMaster will close its connection to the Real Servers by using TCP RESET instead of the normal close handshake. Boolean SubnetOrigin When transparency is disabled for a Virtual Service, the source IP address of connections to Real Servers is the Virtual Service. When enabled, the source IP address is the local address of the LoadMaster. If the Real Server is on a subnet, the subnet address of the LoadMaster will be used. Boolean SubnetOriginating When transparency is disabled for a Virtual Service, the source IP address of connections to Real Servers is the Virtual Service. When enabled, the source IP address is the local address of the LoadMaster. If the Real Server is on a subnet, the subnet address of the LoadMaster will be used. Boolean TCPTimeStamp The LoadMaster can include a timestamp in the SYN when connecting to Real Servers. Only enable this option when requested to from KEMP Support. Boolean RouteFilter When enabled, this option only accepts IP frames from a host over the interface where the routing algorithm would route frames to the host. This is known as strict source route validation. Boolean DHKeySize Select the strength of the key used in the Diffe-Hellman key exchanges. If this value is changed, a reboot is required in order to use the new value. The default value is 2048 Bits. Int32 Http_Proxy This option allows clients to specify the HTTP(S) proxy server and port the LoadMaster will use to access the internet. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Set-NetworkConfiguration SNAT Enabling this options allows the LoadMaster to NAT connections from the Real Servers to the internet. Boolean AllowUpload The LoadMaster has been optimized with HTTP workloads in mind. Enabling this option allows non HTTP uploads to work correctly. Boolean ConnTimeout Specify, in seconds, the time a connection can be idle before it is closed. This is independent of Persistency Timeout. Setting a value of 0 resets to the default value of 660 seconds. Int64 KeepAlive By default, the system uses TCP keepalives to check for failed clients. Enabling this option improves the reliability of older TCP connections (SSH sessions). Not normally required for normal HTTP/HTTPS services. Boolean MultiGW Use this option to enable the ability to move the default gateway to a different interface. Boolean NonLocalRS Enable this option to allow assigning non-local Real Servers to Virtual Services. Boolean OnlyDefaultRoutes Enable this option to force traffic from Virtual Services, which have default route entries set, to be routed to the interface where the Virtual Service’s default route is located. Boolean ResetClose When enabled, the LoadMaster will close its connection to the Real Servers by using TCP RESET instead of the normal close handshake. Boolean SubnetOrigin When transparency is disabled for a Virtual Service, the source IP address of connections to Real Servers is the Virtual Service. When enabled, the source IP address is the local address of the LoadMaster. If the Real Server is on a subnet, the subnet address of the LoadMaster will be used. Boolean SubnetOriginating When transparency is disabled for a Virtual Service, the source IP address of connections to Real Servers is the Virtual Service. When enabled, the source IP address is the local address of the LoadMaster. If the Real Server is on a subnet, the subnet address of the LoadMaster will be used. Boolean TCPTimeStamp The LoadMaster can include a timestamp in the SYN when connecting to Real Servers. Only enable this option when requested to from KEMP Support. Boolean RouteFilter When enabled, this option only accepts IP frames from a host over the interface where the routing algorithm would route frames to the host. This is known as strict source route validation. Boolean DHKeySize Select the strength of the key used in the Diffe-Hellman key exchanges. If this value is changed, a reboot is required in order to use the new value. The default value is 2048 Bits. Int32 Http_Proxy This option allows clients to specify the HTTP(S) proxy server and port the LoadMaster will use to access the internet. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String SNAT Enabling this options allows the LoadMaster to NAT connections from the Real Servers to the internet. Boolean Boolean AllowUpload The LoadMaster has been optimized with HTTP workloads in mind. Enabling this option allows non HTTP uploads to work correctly. Boolean Boolean ConnTimeout Specify, in seconds, the time a connection can be idle before it is closed. This is independent of Persistency Timeout. Setting a value of 0 resets to the default value of 660 seconds. Int64 Int64 KeepAlive By default, the system uses TCP keepalives to check for failed clients. Enabling this option improves the reliability of older TCP connections (SSH sessions). Not normally required for normal HTTP/HTTPS services. Boolean Boolean MultiGW Use this option to enable the ability to move the default gateway to a different interface. Boolean Boolean NonLocalRS Enable this option to allow assigning non-local Real Servers to Virtual Services. Boolean Boolean OnlyDefaultRoutes Enable this option to force traffic from Virtual Services, which have default route entries set, to be routed to the interface where the Virtual Service’s default route is located. Boolean Boolean ResetClose When enabled, the LoadMaster will close its connection to the Real Servers by using TCP RESET instead of the normal close handshake. Boolean Boolean SubnetOrigin When transparency is disabled for a Virtual Service, the source IP address of connections to Real Servers is the Virtual Service. When enabled, the source IP address is the local address of the LoadMaster. If the Real Server is on a subnet, the subnet address of the LoadMaster will be used. Boolean Boolean SubnetOriginating When transparency is disabled for a Virtual Service, the source IP address of connections to Real Servers is the Virtual Service. When enabled, the source IP address is the local address of the LoadMaster. If the Real Server is on a subnet, the subnet address of the LoadMaster will be used. Boolean Boolean TCPTimeStamp The LoadMaster can include a timestamp in the SYN when connecting to Real Servers. Only enable this option when requested to from KEMP Support. Boolean Boolean RouteFilter When enabled, this option only accepts IP frames from a host over the interface where the routing algorithm would route frames to the host. This is known as strict source route validation. Boolean Boolean DHKeySize Select the strength of the key used in the Diffe-Hellman key exchanges. If this value is changed, a reboot is required in order to use the new value. The default value is 2048 Bits. Int32 Int32 Http_Proxy This option allows clients to specify the HTTP(S) proxy server and port the LoadMaster will use to access the internet. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String This is a legacy command and cannot be used to set all of the available parameters. Please refer to the Get-Help of the Set-Parameter command to view a full list of parameters that can be configured. -------------------------- Example -------------------------- PS C:\> Set-NetworkConfiguration -SNAT 1 Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Data field...: @{Parameters=} Param........: @{SNAT=yes} SNAT : yes Set-NetworkDNSConfiguration Allows you to set the values of the DNS Configuration options. Set NetworkDNSConfiguration Allows you to set the values of the DNS Configuration options. Set-NetworkDNSConfiguration Hostname The hostname assigned to the LoadMaster. String HA1Hostname When using the LoadMaster in HA mode, this is the host name of the first node. If the LoadMaster is not in HA mode, then this will return an error. String HA2Hostname When using the LoadMaster in HA mode, this is the host name of the second node. If the LoadMaster is not in HA mode, then this will return an error. String NameServer The DNS server the LoadMaster will use for name resolution. String Searchlist The domain suffix search list when performing DNS resolution. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Set-NetworkDNSConfiguration Hostname The hostname assigned to the LoadMaster. String HA1Hostname When using the LoadMaster in HA mode, this is the host name of the first node. If the LoadMaster is not in HA mode, then this will return an error. String HA2Hostname When using the LoadMaster in HA mode, this is the host name of the second node. If the LoadMaster is not in HA mode, then this will return an error. String NameServer The DNS server the LoadMaster will use for name resolution. String Searchlist The domain suffix search list when performing DNS resolution. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String Hostname The hostname assigned to the LoadMaster. String String HA1Hostname When using the LoadMaster in HA mode, this is the host name of the first node. If the LoadMaster is not in HA mode, then this will return an error. String String HA2Hostname When using the LoadMaster in HA mode, this is the host name of the second node. If the LoadMaster is not in HA mode, then this will return an error. String String NameServer The DNS server the LoadMaster will use for name resolution. String String Searchlist The domain suffix search list when performing DNS resolution. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String This is a legacy command and cannot be used to set all of the available parameters. Please refer to the Get-Help of the Set-Parameter command to view a full list of parameters that can be configured. -------------------------- Example -------------------------- PS C:\> Set-NetworkDNSConfiguration -NameServer 10.154.33.22 Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Data field...: @{Parameters=} Param........: @{nameserver=10.154.33.22} nameserver : 10.154.33.22 Set-NetworkInterface Allows you to set the values of the options of the specified interface. Set NetworkInterface Allows you to set the values of the options of the specified interface. Set-NetworkInterface InterfaceID The ID of the network interface. Int16 IPAddress The IP Address to be assigned to the specified network interface. String MTU The MTU setting for this interface. Int32 HACheck This parameter is only relevant in a HA/cluster configuration. Specify whether or not to use this interface for HA/cluster checks. 0 – Not used for HA/cluster checks 1 – Used for HA/cluster checks The default interface used for checking is eth0. When this option is enabled for an interface, you are prevented from disabling it on that interface. To switch to another interface, specify hacheck=yes/1 for a different interface. You cannot disable this parameter by specifying hacheck=no/0. Boolean GWIface Specifies if this is a network gateway interface. Boolean clupdate Enable this to use this interface for cluster synchronization operations. There must be exactly one interface that is configured for cluster updates. The default interface used for updates is eth0. When this option is enabled for an interface, you are prevented from disabling it on that interface. To switch to another interface, specify clupdate=yes/1 for a different interface. You cannot disable this parameter by specifying clupdate=no/0. Boolean GeoTraffic Specify whether or not to use this interface for GEO responses and requests. Boolean BondMode The bond mode determines the way in which traffic sent out of the bonded interface is actually dispersed over the real interfaces. String Partner IP address of the partner machine (HA only). String Shared IP address of the shared address (HA only). String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Set-NetworkInterface InterfaceID The ID of the network interface. Int16 IPAddress The IP Address to be assigned to the specified network interface. String MTU The MTU setting for this interface. Int32 HACheck This parameter is only relevant in a HA/cluster configuration. Specify whether or not to use this interface for HA/cluster checks. 0 – Not used for HA/cluster checks 1 – Used for HA/cluster checks The default interface used for checking is eth0. When this option is enabled for an interface, you are prevented from disabling it on that interface. To switch to another interface, specify hacheck=yes/1 for a different interface. You cannot disable this parameter by specifying hacheck=no/0. Boolean GWIface Specifies if this is a network gateway interface. Boolean clupdate Enable this to use this interface for cluster synchronization operations. There must be exactly one interface that is configured for cluster updates. The default interface used for updates is eth0. When this option is enabled for an interface, you are prevented from disabling it on that interface. To switch to another interface, specify clupdate=yes/1 for a different interface. You cannot disable this parameter by specifying clupdate=no/0. Boolean GeoTraffic Specify whether or not to use this interface for GEO responses and requests. Boolean BondMode The bond mode determines the way in which traffic sent out of the bonded interface is actually dispersed over the real interfaces. String Partner IP address of the partner machine (HA only). String Shared IP address of the shared address (HA only). String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String InterfaceID The ID of the network interface. Int16 Int16 IPAddress The IP Address to be assigned to the specified network interface. String String MTU The MTU setting for this interface. Int32 Int32 HACheck This parameter is only relevant in a HA/cluster configuration. Specify whether or not to use this interface for HA/cluster checks. 0 – Not used for HA/cluster checks 1 – Used for HA/cluster checks The default interface used for checking is eth0. When this option is enabled for an interface, you are prevented from disabling it on that interface. To switch to another interface, specify hacheck=yes/1 for a different interface. You cannot disable this parameter by specifying hacheck=no/0. Boolean Boolean GWIface Specifies if this is a network gateway interface. Boolean Boolean clupdate Enable this to use this interface for cluster synchronization operations. There must be exactly one interface that is configured for cluster updates. The default interface used for updates is eth0. When this option is enabled for an interface, you are prevented from disabling it on that interface. To switch to another interface, specify clupdate=yes/1 for a different interface. You cannot disable this parameter by specifying clupdate=no/0. Boolean Boolean GeoTraffic Specify whether or not to use this interface for GEO responses and requests. Boolean Boolean BondMode The bond mode determines the way in which traffic sent out of the bonded interface is actually dispersed over the real interfaces. String String Partner IP address of the partner machine (HA only). String String Shared IP address of the shared address (HA only). String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Set-NetworkInterface -MTU 1400 Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Id : 0 IPAddress : 10.154.11.180/16 Mtu : 1400 InterfaceType : Port GeoTrafficEnable : yes DefaultInterface : yes Set-NetworkOptions WARNING: This function is deprecated. Use the following command instead: Set-NetworkConfiguration Set NetworkOptions WARNING: This function is deprecated. Use the following command instead: Set-NetworkConfiguration Set-NetworkOptions SNAT Boolean AllowUpload Boolean ConnTimeout Int64 KeepAlive Boolean MultiGW Boolean NonLocalRS Boolean OnlyDefaultRoutes Boolean ResetClose Boolean SubnetOrigin Boolean SubnetOriginating Boolean TCPTimeStamp Boolean RouteFilter Boolean DHKeySize Int32 Http_Proxy String LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String Set-NetworkOptions SNAT Boolean AllowUpload Boolean ConnTimeout Int64 KeepAlive Boolean MultiGW Boolean NonLocalRS Boolean OnlyDefaultRoutes Boolean ResetClose Boolean SubnetOrigin Boolean SubnetOriginating Boolean TCPTimeStamp Boolean RouteFilter Boolean DHKeySize Int32 Http_Proxy String LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String SNAT Boolean Boolean AllowUpload Boolean Boolean ConnTimeout Int64 Int64 KeepAlive Boolean Boolean MultiGW Boolean Boolean NonLocalRS Boolean Boolean OnlyDefaultRoutes Boolean Boolean ResetClose Boolean Boolean SubnetOrigin Boolean Boolean SubnetOriginating Boolean Boolean TCPTimeStamp Boolean Boolean RouteFilter Boolean Boolean DHKeySize Int32 Int32 Http_Proxy String String LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String Set-NetworkSNMPConfiguration Allows you to set the values of the various SNMP options. Set NetworkSNMPConfiguration Allows you to set the values of the various SNMP options. Set-NetworkSNMPConfiguration SNMPEnable Enable or disable SNMP. Boolean SNMPv3enable Enable SNMP V3. 0 - Disabled 1 - Enabled Boolean SNMPv3user Specify the username. String SNMPv3userpasswd Specify the user password. String snmpAuthProt Specify the relevant authentication protocol: - MD5 - SHA SHA is a more secure protocol. Note: These values are case sensitive - please enter them in uppercase. String snmpPrivProt Specify the relevant privacy protocol: - DES - AES AES is a more secure protocol. Note: These values are case sensitive - please enter them in uppercase. String SNMPClient Specify the list of machines that can access the SNMP subsystem. If no clients are specified, then anyone can access SNMP. String SNMPCommunity Specify the SNMP community string. String SNMPContact Specify the contact address that is sent in SNMP responses. String SNMPLocation Specify the location that is sent in SNMP responses. String SNMPTrapEnable Enable the generation of SNMP events whenever a significant event occurs. Boolean SNMPHaTrap Send SNMP traps from the shared IP address. This option is only available when the LoadMaster is in HA mode. Boolean SNMPv1Sink Specify the sink address for SNMP type 1 traps. String SNMPv2Sink Specify the sink address for SNMP type 2 traps. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Set-NetworkSNMPConfiguration SNMPEnable Enable or disable SNMP. Boolean SNMPv3enable Enable SNMP V3. 0 - Disabled 1 - Enabled Boolean SNMPv3user Specify the username. String SNMPv3userpasswd Specify the user password. String snmpAuthProt Specify the relevant authentication protocol: - MD5 - SHA SHA is a more secure protocol. Note: These values are case sensitive - please enter them in uppercase. String snmpPrivProt Specify the relevant privacy protocol: - DES - AES AES is a more secure protocol. Note: These values are case sensitive - please enter them in uppercase. String SNMPClient Specify the list of machines that can access the SNMP subsystem. If no clients are specified, then anyone can access SNMP. String SNMPCommunity Specify the SNMP community string. String SNMPContact Specify the contact address that is sent in SNMP responses. String SNMPLocation Specify the location that is sent in SNMP responses. String SNMPTrapEnable Enable the generation of SNMP events whenever a significant event occurs. Boolean SNMPHaTrap Send SNMP traps from the shared IP address. This option is only available when the LoadMaster is in HA mode. Boolean SNMPv1Sink Specify the sink address for SNMP type 1 traps. String SNMPv2Sink Specify the sink address for SNMP type 2 traps. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String SNMPEnable Enable or disable SNMP. Boolean Boolean SNMPv3enable Enable SNMP V3. 0 - Disabled 1 - Enabled Boolean Boolean SNMPv3user Specify the username. String String SNMPv3userpasswd Specify the user password. String String snmpAuthProt Specify the relevant authentication protocol: - MD5 - SHA SHA is a more secure protocol. Note: These values are case sensitive - please enter them in uppercase. String String snmpPrivProt Specify the relevant privacy protocol: - DES - AES AES is a more secure protocol. Note: These values are case sensitive - please enter them in uppercase. String String SNMPClient Specify the list of machines that can access the SNMP subsystem. If no clients are specified, then anyone can access SNMP. String String SNMPCommunity Specify the SNMP community string. String String SNMPContact Specify the contact address that is sent in SNMP responses. String String SNMPLocation Specify the location that is sent in SNMP responses. String String SNMPTrapEnable Enable the generation of SNMP events whenever a significant event occurs. Boolean Boolean SNMPHaTrap Send SNMP traps from the shared IP address. This option is only available when the LoadMaster is in HA mode. Boolean Boolean SNMPv1Sink Specify the sink address for SNMP type 1 traps. String String SNMPv2Sink Specify the sink address for SNMP type 2 traps. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String The generic Get-Parameter and Set-Parameter commands can also be used to retrieve and update these parameters. -------------------------- Example -------------------------- PS C:\> Set-NetworkSNMPConfiguration -SNMPv3enable 1 Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed; Data=} Return Code..: 200 Response.....: Command successfully executed SNMPEnable : yes SNMPv3enable : yes SNMPv3user : SNMPv3userpasswd : ******** snmpAuthProt : snmpPrivProt : SNMPClient : SNMPCommunity : SNMPContact : SNMPLocation : SNMPTrapEnable : no Set-PacketFilterOptionACL Sets a packet filtering option. Set PacketFilterOptionACL Sets a packet filtering option. This can also be used to enable or disable packet filtering. Note that packet filtering cannot be disabled if the GEO feature is enabled. Set-PacketFilterOptionACL Option The following packet filtering options are supported: enable, drop or ifblock: The enable option indicates whether packet filtering is enabled or disabled on the LoadMaster. Note that packet filtering is enabled by default and cannot be disabled if the GEO feature is enabled. If packet filtering is enabled, the drop option indicates whether the LoadMaster silently drops blocked packets or rejects them by responding with an ICMP reject packet. For security reasons it is usually best to drop any blocked packets silently. If packet filtering is enabled, the ifblock option indicates whether the LoadMaster restricts network traffic by imposing restrictions upon routing between attached subnets. String Value pecify whether to enable or disable the specified Option: 0 – Disabled 1 – Enabled Boolean LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Set-PacketFilterOptionACL Option The following packet filtering options are supported: enable, drop or ifblock: The enable option indicates whether packet filtering is enabled or disabled on the LoadMaster. Note that packet filtering is enabled by default and cannot be disabled if the GEO feature is enabled. If packet filtering is enabled, the drop option indicates whether the LoadMaster silently drops blocked packets or rejects them by responding with an ICMP reject packet. For security reasons it is usually best to drop any blocked packets silently. If packet filtering is enabled, the ifblock option indicates whether the LoadMaster restricts network traffic by imposing restrictions upon routing between attached subnets. String Value pecify whether to enable or disable the specified Option: 0 – Disabled 1 – Enabled Boolean LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String Option The following packet filtering options are supported: enable, drop or ifblock: The enable option indicates whether packet filtering is enabled or disabled on the LoadMaster. Note that packet filtering is enabled by default and cannot be disabled if the GEO feature is enabled. If packet filtering is enabled, the drop option indicates whether the LoadMaster silently drops blocked packets or rejects them by responding with an ICMP reject packet. For security reasons it is usually best to drop any blocked packets silently. If packet filtering is enabled, the ifblock option indicates whether the LoadMaster restricts network traffic by imposing restrictions upon routing between attached subnets. String String Value pecify whether to enable or disable the specified Option: 0 – Disabled 1 – Enabled Boolean Boolean LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Set-PacketFilterOptionACL -Option drop -Value 0 Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Set-Parameter WARNING: This function is deprecated. Use the following command instead: Set-LmParameter Set Parameter WARNING: This function is deprecated. Use the following command instead: Set-LmParameter Set-Parameter Param String Value String LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String Set-Parameter Param String Value String LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String Param String String Value String String LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String Set-RealServer WARNING: This function is deprecated. Use the following command instead: Set-AdcRealServer Set RealServer WARNING: This function is deprecated. Use the following command instead: Set-AdcRealServer Set-RealServer VirtualService String VSPort Int32 VSProtocol String VSIndex Int32 RealServer String RealServerPort Int32 RSIndex Int32 NewPort Int32 Weight Int32 Forward String Enable Boolean Limit Int64 Critical Boolean Follow Int32 LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String Set-RealServer VirtualService String VSPort Int32 VSProtocol String VSIndex Int32 RealServer String RealServerPort Int32 RSIndex Int32 NewPort Int32 Weight Int32 Forward String Enable Boolean Limit Int64 Critical Boolean Follow Int32 LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String VirtualService String String VSPort Int32 Int32 VSProtocol String String VSIndex Int32 Int32 RealServer String String RealServerPort Int32 Int32 RSIndex Int32 Int32 NewPort Int32 Int32 Weight Int32 Int32 Forward String String Enable Boolean Boolean Limit Int64 Int64 Critical Boolean Boolean Follow Int32 Int32 LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String Set-Rule WARNING: This function is deprecated. Use the following command instead: Set-AdcContentRule Set Rule WARNING: This function is deprecated. Use the following command instead: Set-AdcContentRule Set-Rule RuleName String MatchType String IncHost Boolean NoCase Boolean Negate Boolean IncQuery Boolean Header String Pattern String Replacement String Type Int32 LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String Set-Rule RuleName String MatchType String IncHost Boolean NoCase Boolean Negate Boolean IncQuery Boolean Header String Pattern String Replacement String Type Int32 LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String RuleName String String MatchType String String IncHost Boolean Boolean NoCase Boolean Boolean Negate Boolean Boolean IncQuery Boolean Boolean Header String String Pattern String String Replacement String String Type Int32 Int32 LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String Set-SAMLSPEntity Use this command to set values for some SAML-related parameters. Set SAMLSPEntity Use this command to set values for some SAML-related parameters. Set-SAMLSPEntity Domain The domain name of the relevant domain to be updated. String IdpEntityId Specify the Identity Service Provider (IdP) Entity ID. String IdpSsoUrl Specify the IdP Single Sign On (SSO) URL. String IdpLogoffUrl Specify the IdP Logoff URL. String IdpCert Specify the IdP certificate to use for verification processing. String SpEntityId The Service Provider (SP) entity ID is an identifier that is shared to enable the IdP to understand, accept and have knowledge of the entity when request messages are sent from the LoadMaster. This must correlate to the identifier of the relying party on the AD FS server. String SpCert It is optional to sign requests that are sent in the context of logon. Currently, the LoadMaster does not sign those requests. In the context of log off requests – it is mandatory and these requests must be signed. This is to avoid any spoofing and to provide extra security in relation to log off functionality. This ensures that users are not being hacked and not being logged off unnecessarily. Using the SpCert parameter, you can choose to use a self-signed certificate or third party certificate to perform the signing. To specify a self-signed certificate, set sp_cert to useselfsigned. To use a third party certificate, specify the name of the certificate to use (this certificate must be uploaded to the LoadMaster before it can be selected). String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Set-SAMLSPEntity Domain The domain name of the relevant domain to be updated. String IdpEntityId Specify the Identity Service Provider (IdP) Entity ID. String IdpSsoUrl Specify the IdP Single Sign On (SSO) URL. String IdpLogoffUrl Specify the IdP Logoff URL. String IdpCert Specify the IdP certificate to use for verification processing. String SpEntityId The Service Provider (SP) entity ID is an identifier that is shared to enable the IdP to understand, accept and have knowledge of the entity when request messages are sent from the LoadMaster. This must correlate to the identifier of the relying party on the AD FS server. String SpCert It is optional to sign requests that are sent in the context of logon. Currently, the LoadMaster does not sign those requests. In the context of log off requests – it is mandatory and these requests must be signed. This is to avoid any spoofing and to provide extra security in relation to log off functionality. This ensures that users are not being hacked and not being logged off unnecessarily. Using the SpCert parameter, you can choose to use a self-signed certificate or third party certificate to perform the signing. To specify a self-signed certificate, set sp_cert to useselfsigned. To use a third party certificate, specify the name of the certificate to use (this certificate must be uploaded to the LoadMaster before it can be selected). String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String Domain The domain name of the relevant domain to be updated. String String IdpEntityId Specify the Identity Service Provider (IdP) Entity ID. String String IdpSsoUrl Specify the IdP Single Sign On (SSO) URL. String String IdpLogoffUrl Specify the IdP Logoff URL. String String IdpCert Specify the IdP certificate to use for verification processing. String String SpEntityId The Service Provider (SP) entity ID is an identifier that is shared to enable the IdP to understand, accept and have knowledge of the entity when request messages are sent from the LoadMaster. This must correlate to the identifier of the relying party on the AD FS server. String String SpCert It is optional to sign requests that are sent in the context of logon. Currently, the LoadMaster does not sign those requests. In the context of log off requests – it is mandatory and these requests must be signed. This is to avoid any spoofing and to provide extra security in relation to log off functionality. This ensures that users are not being hacked and not being logged off unnecessarily. Using the SpCert parameter, you can choose to use a self-signed certificate or third party certificate to perform the signing. To specify a self-signed certificate, set sp_cert to useselfsigned. To use a third party certificate, specify the name of the certificate to use (this certificate must be uploaded to the LoadMaster before it can be selected). String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Set-SAMLSPEntity -Domain example2.com -IdpEntityId idp-3.example.com Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Data field...: @{Domain=} Param........: @{Id=9; Name=EXAMPLE2.COM; server=10.154.45.22; auth_type=SAML; idp_entity_id=; idp_sso_url=; idp_logoff_url=; idp_cert=; sp_entity_id=id p-3.example.com; sp_cert=UseSelfSigned; sess_tout_type=idle time; sess_tout_idle_pub=900; sess_tout_duration_pub=1800} Id : 9 Name : EXAMPLE2.COM server : 10.154.45.22 auth_type : SAML idp_entity_id : idp_sso_url : idp_logoff_url : idp_cert : sp_entity_id : idp-3.example.com sp_cert : UseSelfSigned sess_tout_type : idle time sess_tout_idle_pub : 900 sess_tout_duration_pub : 1800 Set-SdnController Used to change the details of an SDN controller. Set SdnController Used to change the details of an SDN controller. Set-SdnController Cid The ID of the controller to be modified. To get the controller ID, run the getsdncontroller command. Int32 Clid The cluster ID for the SDN controller for changing. Int32 IPV4 The IPv4 address of the SDN controller. String Port The port of the SDN controller. Int32 Https The HTTP method to use. Boolean User The username to be used to access the SDN controller PowerShell API. String Password The password to be used to access the SDN controller PowerShell API. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Set-SdnController Cid The ID of the controller to be modified. To get the controller ID, run the getsdncontroller command. Int32 Clid The cluster ID for the SDN controller for changing. Int32 IPV4 The IPv4 address of the SDN controller. String Port The port of the SDN controller. Int32 Https The HTTP method to use. Boolean User The username to be used to access the SDN controller PowerShell API. String Password The password to be used to access the SDN controller PowerShell API. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String Cid The ID of the controller to be modified. To get the controller ID, run the getsdncontroller command. Int32 Int32 Clid The cluster ID for the SDN controller for changing. Int32 Int32 IPV4 The IPv4 address of the SDN controller. String String Port The port of the SDN controller. Int32 Int32 Https The HTTP method to use. Boolean Boolean User The username to be used to access the SDN controller PowerShell API. String String Password The password to be used to access the SDN controller PowerShell API. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String If any mandatory parameters are missing, you will be prompted to enter them. -------------------------- Example -------------------------- PS C:\> Set-SdnController -Cid 56 -Https 0 Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=Data} Return Code..: 200 Response.....: Command successfully executed. Set-SecAdminAccess Allows you to set the web administrative access interface and the administrative default gateway. Set SecAdminAccess Allows you to set the web administrative access interface and the administrative default gateway. Set-SecAdminAccess WuiNetworkInterfaceId The index of an existing interface. This index number corresponds to the interface number in the LoadMaster WUI, i.e. the index for eth0 is 0. Int32 WuiPort Specify the port used to access the administrative web interface. Int32 WuiDefaultGateway When administering the LoadMaster from a non-default interface, a different default gateway for administrative traffic only can be specified using this parameter. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Set-SecAdminAccess WuiNetworkInterfaceId The index of an existing interface. This index number corresponds to the interface number in the LoadMaster WUI, i.e. the index for eth0 is 0. Int32 WuiPort Specify the port used to access the administrative web interface. Int32 WuiDefaultGateway When administering the LoadMaster from a non-default interface, a different default gateway for administrative traffic only can be specified using this parameter. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String WuiNetworkInterfaceId The index of an existing interface. This index number corresponds to the interface number in the LoadMaster WUI, i.e. the index for eth0 is 0. Int32 Int32 WuiPort Specify the port used to access the administrative web interface. Int32 Int32 WuiDefaultGateway When administering the LoadMaster from a non-default interface, a different default gateway for administrative traffic only can be specified using this parameter. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Set-SecAdminAccess -WuiNetworkInterfaceId 0 -WuiPort 443 Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Data field...: @{SecAdminAccessConfiguration=} Param........: @{WuiDefaultGateway=; WuiNetworkInterfaceId=0; WuiPort=443} Set-SecAdminWuiConfiguration Configure the admin WUI configuration settings. Set SecAdminWuiConfiguration Set parameters such as the WUICipherset and WUITLSProtocols. Set-SecAdminWuiConfiguration WUITLSProtocols Specify whether or not it is possible to connect to the LoadMaster WUI using the following protocols; SSLv3, TLS1.0, TLS1.1 or TLS1.2. The protocols can be enabled and disabled using a bitmask value in the range 0 to 14. Refer to the table below to find out what number corresponds to which settings. Number | SSLv3 | TLS1.0 | TLS1.1 | TLS1.2 0 | Enabled | Enabled | Enabled | Enabled 1 | Disabled | Enabled | Enabled | Enabled 2 | Enabled | Disabled | Enabled | Enabled 3 | Disabled | Disabled | Enabled | Enabled 4 | Enabled | Enabled | Disabled | Enabled 5 | Disabled | Enabled | Disabled | Enabled 6 | Enabled | Disabled | Disabled | Enabled 7 | Disabled | Disabled | Disabled | Enabled 8 | Enabled | Enabled | Enabled | Disabled 9 | Disabled | Enabled | Enabled | Disabled 10 | Enabled | Disabled | Enabled | Disabled 11 | Disabled | Disabled | Enabled | Disabled 12 | Enabled | Enabled | Disabled | Disabled 13 | Disabled | Enabled | Disabled | Disabled 14 | Enabled | Disabled | Disabled | Disabled Int32 WUICipherset Specify the cipher set to use for the LoadMaster WUI. The valid values are below: - Default - Default_NoRc4 - BestPractices - Intermediate_compatibility - Backward_compatibility - WUI - FIPS - Legacy - <NameOfCustomCipherSet> Specify the cipher set to use for the LoadMaster WUI. String sessioncontrol Enables or disables session control. Boolean sessionbasicauth If the SessionControl and SessionBasicAuth parameters are both enabled, there are two levels of authentication enforced in order to access the LoadMaster WUI. The initial level is Basic Authentication where users log in using the bal or user logins, which are default usernames defined by the system. Boolean sessionmaxfailattempts Number of failed attempts before locking the user account. This can be set from 1 to 999. Int16 sessionidletime Specifies the number of seconds that the WUI can be idle before logging the user out. This can be set from 60 to 86400 seconds. Int32 sessionconcurrent Limit the maximum number of concurrent connections a single user can have. Range: 0 to 9. A value of 0, means logins are unlimited. Int16 wuipreauth Set the pre-authentication click through banner which will be displayed before the LoadMaster login page. This parameter can contain plain text or HTML code. The field cannot contain JavaScript. This field accepts up to 5,000 characters. Anything past the 5,000 character limit will not be displayed. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Set-SecAdminWuiConfiguration WUITLSProtocols Specify whether or not it is possible to connect to the LoadMaster WUI using the following protocols; SSLv3, TLS1.0, TLS1.1 or TLS1.2. The protocols can be enabled and disabled using a bitmask value in the range 0 to 14. Refer to the table below to find out what number corresponds to which settings. Number | SSLv3 | TLS1.0 | TLS1.1 | TLS1.2 0 | Enabled | Enabled | Enabled | Enabled 1 | Disabled | Enabled | Enabled | Enabled 2 | Enabled | Disabled | Enabled | Enabled 3 | Disabled | Disabled | Enabled | Enabled 4 | Enabled | Enabled | Disabled | Enabled 5 | Disabled | Enabled | Disabled | Enabled 6 | Enabled | Disabled | Disabled | Enabled 7 | Disabled | Disabled | Disabled | Enabled 8 | Enabled | Enabled | Enabled | Disabled 9 | Disabled | Enabled | Enabled | Disabled 10 | Enabled | Disabled | Enabled | Disabled 11 | Disabled | Disabled | Enabled | Disabled 12 | Enabled | Enabled | Disabled | Disabled 13 | Disabled | Enabled | Disabled | Disabled 14 | Enabled | Disabled | Disabled | Disabled Int32 WUICipherset Specify the cipher set to use for the LoadMaster WUI. The valid values are below: - Default - Default_NoRc4 - BestPractices - Intermediate_compatibility - Backward_compatibility - WUI - FIPS - Legacy - <NameOfCustomCipherSet> Specify the cipher set to use for the LoadMaster WUI. String sessioncontrol Enables or disables session control. Boolean sessionbasicauth If the SessionControl and SessionBasicAuth parameters are both enabled, there are two levels of authentication enforced in order to access the LoadMaster WUI. The initial level is Basic Authentication where users log in using the bal or user logins, which are default usernames defined by the system. Boolean sessionmaxfailattempts Number of failed attempts before locking the user account. This can be set from 1 to 999. Int16 sessionidletime Specifies the number of seconds that the WUI can be idle before logging the user out. This can be set from 60 to 86400 seconds. Int32 sessionconcurrent Limit the maximum number of concurrent connections a single user can have. Range: 0 to 9. A value of 0, means logins are unlimited. Int16 wuipreauth Set the pre-authentication click through banner which will be displayed before the LoadMaster login page. This parameter can contain plain text or HTML code. The field cannot contain JavaScript. This field accepts up to 5,000 characters. Anything past the 5,000 character limit will not be displayed. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String WUITLSProtocols Specify whether or not it is possible to connect to the LoadMaster WUI using the following protocols; SSLv3, TLS1.0, TLS1.1 or TLS1.2. The protocols can be enabled and disabled using a bitmask value in the range 0 to 14. Refer to the table below to find out what number corresponds to which settings. Number | SSLv3 | TLS1.0 | TLS1.1 | TLS1.2 0 | Enabled | Enabled | Enabled | Enabled 1 | Disabled | Enabled | Enabled | Enabled 2 | Enabled | Disabled | Enabled | Enabled 3 | Disabled | Disabled | Enabled | Enabled 4 | Enabled | Enabled | Disabled | Enabled 5 | Disabled | Enabled | Disabled | Enabled 6 | Enabled | Disabled | Disabled | Enabled 7 | Disabled | Disabled | Disabled | Enabled 8 | Enabled | Enabled | Enabled | Disabled 9 | Disabled | Enabled | Enabled | Disabled 10 | Enabled | Disabled | Enabled | Disabled 11 | Disabled | Disabled | Enabled | Disabled 12 | Enabled | Enabled | Disabled | Disabled 13 | Disabled | Enabled | Disabled | Disabled 14 | Enabled | Disabled | Disabled | Disabled Int32 Int32 WUICipherset Specify the cipher set to use for the LoadMaster WUI. The valid values are below: - Default - Default_NoRc4 - BestPractices - Intermediate_compatibility - Backward_compatibility - WUI - FIPS - Legacy - <NameOfCustomCipherSet> Specify the cipher set to use for the LoadMaster WUI. String String sessioncontrol Enables or disables session control. Boolean Boolean sessionbasicauth If the SessionControl and SessionBasicAuth parameters are both enabled, there are two levels of authentication enforced in order to access the LoadMaster WUI. The initial level is Basic Authentication where users log in using the bal or user logins, which are default usernames defined by the system. Boolean Boolean sessionmaxfailattempts Number of failed attempts before locking the user account. This can be set from 1 to 999. Int16 Int16 sessionidletime Specifies the number of seconds that the WUI can be idle before logging the user out. This can be set from 60 to 86400 seconds. Int32 Int32 sessionconcurrent Limit the maximum number of concurrent connections a single user can have. Range: 0 to 9. A value of 0, means logins are unlimited. Int16 Int16 wuipreauth Set the pre-authentication click through banner which will be displayed before the LoadMaster login page. This parameter can contain plain text or HTML code. The field cannot contain JavaScript. This field accepts up to 5,000 characters. Anything past the 5,000 character limit will not be displayed. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Set-SecAdminWuiConfiguration Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Data field...: @{Parameters=} Param........: @{sessionmaxfailattempts=5} Set-SecRemoteAccess Allows you to set the values of Remote Access options. Set SecRemoteAccess Allows you to set the values of Remote Access options. Set-SecRemoteAccess SSHAccess Specify over which addresses remote administrative SSH access to the LoadMaster is allowed. Boolean SSHIface Specify the addresses over which remote administrative SSH access to the LoadMaster is allowed. String SSHPort Specify the port used to access the LoadMaster via the SSH protocol. Int32 SSHPreAuthBanner Set the SSH pre-authentication banner, which is displayed before the login prompt when logging in using SSH. Space characters should be escaped by entering %20. This field accepts up to 5,000 characters. Anything past the 5,000 character limit will not be displayed. String WUIAccess Enables or disables WUI access. Boolean MultiHomedWui Allow WUI access from multiple interfaces. Apart from the main administrative interface, each interface can then be enabled to allow WUI access. Boolean EnableAPI The EnableAPI parameter is deprecated. Please use the Enable/Disable-SecAPIAccess commands instead. Boolean AllowUpdateChecks Allow the LoadMaster to regularly check the KEMP website for new software versions. Boolean GeoClients Set the addresses of the GEO LoadMasters which can retrieve service status information from the LoadMaster. To unset this, set the value to an empty string. String GeoPartners Set the IP address of the GEO LoadMaster partner(s). These GEO LoadMasters will keep their DNS configurations in sync. To unset this, set the value to an empty string. Note: Before partnering GEO LoadMasters, a backup should be taken of the relevant GEO LoadMaster which has the correct/preferred configuration. This backup should then be restored to the other LoadMasters that will be partnered with the original LoadMaster. String GeoSSHPort The port over which GEO LoadMasters will communicate with on another. Int32 geo_ssh_iface Specify the ID of the GEO interface in which the SSH partner tunnel is created, for example setting this to 0 means the interface eth0. This is the interface that the GEO partners will communicate through. Int32 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Set-SecRemoteAccess SSHAccess Specify over which addresses remote administrative SSH access to the LoadMaster is allowed. Boolean SSHIface Specify the addresses over which remote administrative SSH access to the LoadMaster is allowed. String SSHPort Specify the port used to access the LoadMaster via the SSH protocol. Int32 SSHPreAuthBanner Set the SSH pre-authentication banner, which is displayed before the login prompt when logging in using SSH. Space characters should be escaped by entering %20. This field accepts up to 5,000 characters. Anything past the 5,000 character limit will not be displayed. String WUIAccess Enables or disables WUI access. Boolean MultiHomedWui Allow WUI access from multiple interfaces. Apart from the main administrative interface, each interface can then be enabled to allow WUI access. Boolean EnableAPI The EnableAPI parameter is deprecated. Please use the Enable/Disable-SecAPIAccess commands instead. Boolean AllowUpdateChecks Allow the LoadMaster to regularly check the KEMP website for new software versions. Boolean GeoClients Set the addresses of the GEO LoadMasters which can retrieve service status information from the LoadMaster. To unset this, set the value to an empty string. String GeoPartners Set the IP address of the GEO LoadMaster partner(s). These GEO LoadMasters will keep their DNS configurations in sync. To unset this, set the value to an empty string. Note: Before partnering GEO LoadMasters, a backup should be taken of the relevant GEO LoadMaster which has the correct/preferred configuration. This backup should then be restored to the other LoadMasters that will be partnered with the original LoadMaster. String GeoSSHPort The port over which GEO LoadMasters will communicate with on another. Int32 geo_ssh_iface Specify the ID of the GEO interface in which the SSH partner tunnel is created, for example setting this to 0 means the interface eth0. This is the interface that the GEO partners will communicate through. Int32 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String SSHAccess Specify over which addresses remote administrative SSH access to the LoadMaster is allowed. Boolean Boolean SSHIface Specify the addresses over which remote administrative SSH access to the LoadMaster is allowed. String String SSHPort Specify the port used to access the LoadMaster via the SSH protocol. Int32 Int32 SSHPreAuthBanner Set the SSH pre-authentication banner, which is displayed before the login prompt when logging in using SSH. Space characters should be escaped by entering %20. This field accepts up to 5,000 characters. Anything past the 5,000 character limit will not be displayed. String String WUIAccess Enables or disables WUI access. Boolean Boolean MultiHomedWui Allow WUI access from multiple interfaces. Apart from the main administrative interface, each interface can then be enabled to allow WUI access. Boolean Boolean EnableAPI The EnableAPI parameter is deprecated. Please use the Enable/Disable-SecAPIAccess commands instead. Boolean Boolean AllowUpdateChecks Allow the LoadMaster to regularly check the KEMP website for new software versions. Boolean Boolean GeoClients Set the addresses of the GEO LoadMasters which can retrieve service status information from the LoadMaster. To unset this, set the value to an empty string. String String GeoPartners Set the IP address of the GEO LoadMaster partner(s). These GEO LoadMasters will keep their DNS configurations in sync. To unset this, set the value to an empty string. Note: Before partnering GEO LoadMasters, a backup should be taken of the relevant GEO LoadMaster which has the correct/preferred configuration. This backup should then be restored to the other LoadMasters that will be partnered with the original LoadMaster. String String GeoSSHPort The port over which GEO LoadMasters will communicate with on another. Int32 Int32 geo_ssh_iface Specify the ID of the GEO interface in which the SSH partner tunnel is created, for example setting this to 0 means the interface eth0. This is the interface that the GEO partners will communicate through. Int32 Int32 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String GeoInterfaceId Specify the ID of the GEO interface in which the SSH partner tunnel is created, for example setting this to 0 means the interface eth0. This is the interface that the GEO partners will communicate through. int32 int32 This is a legacy command and cannot be used to set all of the available parameters. Please refer to the Get-Help of the Set-Parameter command to view a full list of parameters that can be configured. -------------------------- Example -------------------------- PS C:\> Set-SecRemoteAccess -GeoPartners 10.154.11.34 Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Param........: @{GeoPartners=10.154.11.34} Set-SecRemoteAccessLoginMethod Configure the Admin Login Method for the LoadMaster Web User Interface (WUI). Set SecRemoteAccessLoginMethod This command sets the Admin Login Method for the WUI, for example, to "Password or Client certificate" or "Password Only Access (default)". Set-SecRemoteAccessLoginMethod LoginMethod Specify the login method. Valid values are: PasswordOnly PasswordorClientCertificate ClientCertificateRequired ClientCertificateRequiredOCSP String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Set-SecRemoteAccessLoginMethod LoginMethod Specify the login method. Valid values are: PasswordOnly PasswordorClientCertificate ClientCertificateRequired ClientCertificateRequiredOCSP String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String LoginMethod Specify the login method. Valid values are: PasswordOnly PasswordorClientCertificate ClientCertificateRequired ClientCertificateRequiredOCSP String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Set-SecRemoteAccessLoginMethod -LoginMethod PasswordOnly Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Set-SecSystemUserPassword Allows you to change the password of the default bal user. Set SecSystemUserPassword Allows you to change the password of the default bal user. Set-SecSystemUserPassword CurrentPassword The current password for the bal user. String NewPassword The new password for the bal user. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String CurrentPassword The current password for the bal user. String String NewPassword The new password for the bal user. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String -------------------------- Example -------------------------- PS C:\> Set-SecSystemUserPassword -CurrPassword 1fourall -Password 2fourall Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Set-SecUserPassword Allows you to change the password of a local user. Set SecUserPassword Allows you to change the password of a local user. Set-SecUserPassword User Username of the relevant user. String Password The new password. String Radius The radius parameter determines whether the user will use RADIUS server authentication or not when logging in to the LoadMaster. The RADIUS server details must be set up before this option can be used. 0 - Do not use RADIUS authentication 1 - Use RADIUS authentication Int32 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Set-SecUserPassword User Username of the relevant user. String Password The new password. String Radius The radius parameter determines whether the user will use RADIUS server authentication or not when logging in to the LoadMaster. The RADIUS server details must be set up before this option can be used. 0 - Do not use RADIUS authentication 1 - Use RADIUS authentication Int32 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String User Username of the relevant user. String String Password The new password. String String Radius The radius parameter determines whether the user will use RADIUS server authentication or not when logging in to the LoadMaster. The RADIUS server details must be set up before this option can be used. 0 - Do not use RADIUS authentication 1 - Use RADIUS authentication Int32 Int32 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Set-SecUserPassword -Password password12345 -Radius 0 -User ExampleUser Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Set-SecUserPermission Allows you to set permissions for a local user. Set SecUserPermission Allows you to set permissions for a local user. Set-SecUserPermission User Username of the relevant user. String Permissions Valid values for the perms parameter are listed and described below. real: This role permits enabling and disabling Real Servers. Users with the Real Servers permission cannot add SubVSs. vs: This role permits managing Virtual Services. This includes SubVSs. Virtual Service modifications permitted include add, delete and modify for any subnet. rules: This role permits managing Rules. Rule modifications permitted include add, delete and modify. backup: This role permits performing system backups. certs: This role permits managing SSL Certificates. Certificate management includes adding, deleting and modifying SSL Certificates. cert3: This role permits managing intermediate Certificates. Certificate management includes the ability to add and delete intermediate certificates. certbackup: This role permits the ability to export and import certificates. users: This role is allowed access to all functionality within the System Configuration > System Administration > User Management WUI screen. root: This role gives users all permissions except the permission to change the bal password and the permission to create or delete other users. geo: This role is used only with the LoadMaster GEO product. For more information on GEO and the Global Server Load Balancing (GSLB) Feature Pack, refer to the GEO, Product Overview. Multiple permissions can be set at the same time by separating the values with a comma. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Set-SecUserPermission User Username of the relevant user. String Permissions Valid values for the perms parameter are listed and described below. real: This role permits enabling and disabling Real Servers. Users with the Real Servers permission cannot add SubVSs. vs: This role permits managing Virtual Services. This includes SubVSs. Virtual Service modifications permitted include add, delete and modify for any subnet. rules: This role permits managing Rules. Rule modifications permitted include add, delete and modify. backup: This role permits performing system backups. certs: This role permits managing SSL Certificates. Certificate management includes adding, deleting and modifying SSL Certificates. cert3: This role permits managing intermediate Certificates. Certificate management includes the ability to add and delete intermediate certificates. certbackup: This role permits the ability to export and import certificates. users: This role is allowed access to all functionality within the System Configuration > System Administration > User Management WUI screen. root: This role gives users all permissions except the permission to change the bal password and the permission to create or delete other users. geo: This role is used only with the LoadMaster GEO product. For more information on GEO and the Global Server Load Balancing (GSLB) Feature Pack, refer to the GEO, Product Overview. Multiple permissions can be set at the same time by separating the values with a comma. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String User Username of the relevant user. String String Permissions Valid values for the perms parameter are listed and described below. real: This role permits enabling and disabling Real Servers. Users with the Real Servers permission cannot add SubVSs. vs: This role permits managing Virtual Services. This includes SubVSs. Virtual Service modifications permitted include add, delete and modify for any subnet. rules: This role permits managing Rules. Rule modifications permitted include add, delete and modify. backup: This role permits performing system backups. certs: This role permits managing SSL Certificates. Certificate management includes adding, deleting and modifying SSL Certificates. cert3: This role permits managing intermediate Certificates. Certificate management includes the ability to add and delete intermediate certificates. certbackup: This role permits the ability to export and import certificates. users: This role is allowed access to all functionality within the System Configuration > System Administration > User Management WUI screen. root: This role gives users all permissions except the permission to change the bal password and the permission to create or delete other users. geo: This role is used only with the LoadMaster GEO product. For more information on GEO and the Global Server Load Balancing (GSLB) Feature Pack, refer to the GEO, Product Overview. Multiple permissions can be set at the same time by separating the values with a comma. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String Perms The valid values for this parameter and their descriptions are below: real - This role permits enabling and disabling Real Servers. Users with the Real Servers permission cannot add SubVSs. vs - This role permits managing Virtual Services. This includes SubVSs. Virtual Service modifications permitted include add, delete and modify for any subnet. rules - This role permits managing Rules. Rule modifications permitted include add, delete and modify. backup - This role permits performing system backups. certs - This role permits managing SSL Certificates. Certificate management includes adding, deleting and modifying SSL Certificates. cert3 - This role permits managing intermediate Certificates. Certificate management includes the ability to add and delete intermediate certificates. certbackup - This role permits the ability to export and import certificates. users - This role is allowed access to all functionality within the System Configuration > System Administration > User Management WUI screen. root - This role gives users all permissions except the permission to change the bal password and the permission to create or delete other users. geo - This role is used only with the LoadMaster GEO product. For more information on GEO and the Global Server Load Balancing (GSLB) Feature Pack, refer to the GEO, Product Overview. To set the permissions to none, leave the parameter blank, for example &perms= string string When entering a comma-separated list of multiple permissions, ensure to begin the value entry with a comma, for example ,rules,vs. -------------------------- Example -------------------------- PS C:\> Set-SecUserPermission -User ExampleUser -Perms ,vs,rules Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Set-SecWuiAuthentication Allows you to set the values of WUI Authentication and Authorization options. Set SecWuiAuthentication Configure options such as the RADIUS configuration settings. Set-SecWuiAuthentication RADIUSServer Specifies the RADIUS server to use for authentication. String RADIUSPort Specifies the TCP port for communication to the RADIUS server. Int64 RADIUSSecret Specifies the password (secret) to the RADIUS server. String RADIUSBackupServer Specifies the backup RADIUS server to use for authentication. String RADIUSBackupPort Specifies the TCP port for the backup RADIUS server. Int64 RADIUSBackupSecret Specifies the password (secret) to the backup RADIUS server. String RADIUSRevalidateInterval Specifies how often a user should be revalidated by the RADIUS server. Int32 WuiLdapEp Specify the LDAP endpoint configuration to use for WUI login authentication. String SessionLocalAuth Enables or disables local authentication. Boolean SessionAuthMode Specifies the authentication mode for the LoadMaster. Refer to the following table for values: RADIUS LDAP Local Value Authent. Author. Authent. Authent. Author. 7 No No No No No 263 Yes No No Yes Yes 775 Yes Yes No Yes Yes 23 No No Yes Yes Yes 22 No No Yes No Yes 788 Yes Yes Yes No No 790 Yes Yes Yes No Yes 791 Yes Yes Yes Yes Yes 789 Yes Yes Yes Yes No 773 Yes Yes No Yes No 262 Yes No No No Yes 774 Yes Yes No No Yes 772 Yes Yes No No No 278 Yes No Yes No No 279 Yes No Yes Yes Yes Int16 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Set-SecWuiAuthentication RADIUSServer Specifies the RADIUS server to use for authentication. String RADIUSPort Specifies the TCP port for communication to the RADIUS server. Int64 RADIUSSecret Specifies the password (secret) to the RADIUS server. String RADIUSBackupServer Specifies the backup RADIUS server to use for authentication. String RADIUSBackupPort Specifies the TCP port for the backup RADIUS server. Int64 RADIUSBackupSecret Specifies the password (secret) to the backup RADIUS server. String RADIUSRevalidateInterval Specifies how often a user should be revalidated by the RADIUS server. Int32 WuiLdapEp Specify the LDAP endpoint configuration to use for WUI login authentication. String SessionLocalAuth Enables or disables local authentication. Boolean SessionAuthMode Specifies the authentication mode for the LoadMaster. Refer to the following table for values: RADIUS LDAP Local Value Authent. Author. Authent. Authent. Author. 7 No No No No No 263 Yes No No Yes Yes 775 Yes Yes No Yes Yes 23 No No Yes Yes Yes 22 No No Yes No Yes 788 Yes Yes Yes No No 790 Yes Yes Yes No Yes 791 Yes Yes Yes Yes Yes 789 Yes Yes Yes Yes No 773 Yes Yes No Yes No 262 Yes No No No Yes 774 Yes Yes No No Yes 772 Yes Yes No No No 278 Yes No Yes No No 279 Yes No Yes Yes Yes Int16 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String RADIUSServer Specifies the RADIUS server to use for authentication. String String RADIUSPort Specifies the TCP port for communication to the RADIUS server. Int64 Int64 RADIUSSecret Specifies the password (secret) to the RADIUS server. String String RADIUSBackupServer Specifies the backup RADIUS server to use for authentication. String String RADIUSBackupPort Specifies the TCP port for the backup RADIUS server. Int64 Int64 RADIUSBackupSecret Specifies the password (secret) to the backup RADIUS server. String String RADIUSRevalidateInterval Specifies how often a user should be revalidated by the RADIUS server. Int32 Int32 WuiLdapEp Specify the LDAP endpoint configuration to use for WUI login authentication. String String SessionLocalAuth Enables or disables local authentication. Boolean Boolean SessionAuthMode Specifies the authentication mode for the LoadMaster. Refer to the following table for values: RADIUS LDAP Local Value Authent. Author. Authent. Authent. Author. 7 No No No No No 263 Yes No No Yes Yes 775 Yes Yes No Yes Yes 23 No No Yes Yes Yes 22 No No Yes No Yes 788 Yes Yes Yes No No 790 Yes Yes Yes No Yes 791 Yes Yes Yes Yes Yes 789 Yes Yes Yes Yes No 773 Yes Yes No Yes No 262 Yes No No No Yes 774 Yes Yes No No Yes 772 Yes Yes No No No 278 Yes No Yes No No 279 Yes No Yes Yes Yes Int16 Int16 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Set-SecWuiAuthentication -RADIUSPort 80 Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Data field...: @{Parameters=} Param........: @{RADIUSPort=80} Set-ServiceHealth WARNING: This function is deprecated. Use the following command instead: Set-AdcServiceHealth Set ServiceHealth WARNING: This function is deprecated. Use the following command instead: Set-AdcServiceHealth Set-ServiceHealth CheckInterval Int16 ConnectTimeout Int16 RetryCount Int16 LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String Set-ServiceHealth CheckInterval Int16 ConnectTimeout Int16 RetryCount Int16 LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String CheckInterval Int16 Int16 ConnectTimeout Int16 Int16 RetryCount Int16 Int16 LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String Set-SNMPOption WARNING: This function is deprecated. Use the following command instead: Set-NetworkSNMPConfiguration Set SNMPOption WARNING: This function is deprecated. Use the following command instead: Set-NetworkSNMPConfiguration Set-SNMPOption SNMPEnable Boolean SNMPv3enable Boolean SNMPv3user String SNMPv3userpasswd String snmpAuthProt String snmpPrivProt String SNMPClient String SNMPCommunity String SNMPContact String SNMPLocation String SNMPTrapEnable Boolean SNMPHaTrap Boolean SNMPv1Sink String SNMPv2Sink String LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String Set-SNMPOption SNMPEnable Boolean SNMPv3enable Boolean SNMPv3user String SNMPv3userpasswd String snmpAuthProt String snmpPrivProt String SNMPClient String SNMPCommunity String SNMPContact String SNMPLocation String SNMPTrapEnable Boolean SNMPHaTrap Boolean SNMPv1Sink String SNMPv2Sink String LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String SNMPEnable Boolean Boolean SNMPv3enable Boolean Boolean SNMPv3user String String SNMPv3userpasswd String String snmpAuthProt String String snmpPrivProt String String SNMPClient String String SNMPCommunity String String SNMPContact String String SNMPLocation String String SNMPTrapEnable Boolean Boolean SNMPHaTrap Boolean Boolean SNMPv1Sink String String SNMPv2Sink String String LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String Set-SSODomain Allows you to set Single Sign-On (SSO) Domain options. Set SSODomain Allows you to set Single Sign-On (SSO) Domain options. Set-SSODomain Domain Specifies the name of the SSO domain LoadMaster entry to be modified. String TLS Specifies the encryption to use for authentication. This parameter accepts "Unencrypted", "StartTLS", and "LDAPS". String Server Specifies the server(s) to authenticate against. String[] Server2 When using dual factor authentication, use the server parameter to set the address of the RADIUS server(s) and use the server2 parameter to set the address of the LDAP server(s). String[] auth_type Specify the transport protocol used to communicate with the authentication server. Possible values are: - LDAP-Unencrypted - LDAP-StartTLS - LDAP-LDAPS - RADIUS - RSA-SECURID - Certificate - KCD - RADIUS and LDAP-Unencrypted - RADIUS and LDAP-StartTLS - RADIUS and LDAP-LDAPS String max_failed_auths The maximum number of failed login attempts before the user is locked out. Range: 0 – 999 0 = Never lock out Int32 reset_fail_tout The time that must elapse before the max_failed_auths counter is reset to 0. This must be less than the unblocktout value. This parameter is only relevant if the max_failed_auths parameter is set to a value greater than 0. Range: 60-86400 Int32 unblock_tout The timeout in seconds before a blocked account is automatically unblocked again. This must be greater than the reset_fail_tout parameter value. Range: 60-86400 Int32 logon_fmt Specify the logon string format used to authenticate to the LDAP/RADIUS server. The Username%20only value is only available if the auth_type is set to a RADIUS or RSA-SecurID protocol. The Username value is not available if the auth_type is set to RADIUS or a RADIUS and LDAP protocol. String logon_fmt2 Specify the logon string format used to authenticate to the server. String logon_domain The login domain to be used. This is also used with the logon format to construct the normalized username, for example: - Principalname: <username>@<domain> - Username: <domain>\<username> String sess_tout_type Specify the type of session timeout to be used: - idle time - max duration String sess_tout_idle_pub The session idle timeout value in seconds. This value is used in a public environment. Range: 60-68400 Int32 sess_tout_duration_pub The maximum duration timeout value for the session in seconds. This value is used in a public environment. Range: 60-86400 Int32 sess_tout_idle_priv The session idle timeout value in seconds. This value is used in a private environment. Range: 60-68400 Int32 sess_tout_duration_priv The maximum duration timeout value for the session in seconds. This value is used in a private environment. Range: 60-86400 Int32 testuser The username that will be used to check the authentication server(s), if you are not using an LDAP endpoint. String testpass The password of the user that will be used to check the authentication server(s), if you are not using an LDAP endpoint. String radius_shared_secret The shared secret to be used between the radius server and the LoadMaster. String kerberos_domain The name of the Kerberos realm. String kerberos_kdc The name of the Kerberos Key Distribution Center (KDC). String kcd_username The username of the Kerberos trusted user. String kcd_password The password of the Kerberos trusted user. String server_side Specify if this is an outbound KCD SSO domain or not. y – KCD n – Not KCD String cert_check_asi This option is only available when the authtype is set to Certificate. When this option is enabled - in addition to checking the validity of the client certificate, the client certificate will also be checked against the altSecurityIdentities (ASI) attribute of the user on the Active Directory. String cert_check_cn Enabling this parameter allows a fallback to check the Common Name (CN) in the certificate when the SAN is not available. String Logon_Transcode Enable or disable the transcode of logon credentials from ISO-8859-1 to UTF-8, when required. 0 - Disable 1 - Enable Boolean ldap_endpoint Specify the name of an existing LDAP endpoint to use. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Set-SSODomain Domain Specifies the name of the SSO domain LoadMaster entry to be modified. String TLS Specifies the encryption to use for authentication. This parameter accepts "Unencrypted", "StartTLS", and "LDAPS". String Server Specifies the server(s) to authenticate against. String[] Server2 When using dual factor authentication, use the server parameter to set the address of the RADIUS server(s) and use the server2 parameter to set the address of the LDAP server(s). String[] auth_type Specify the transport protocol used to communicate with the authentication server. Possible values are: - LDAP-Unencrypted - LDAP-StartTLS - LDAP-LDAPS - RADIUS - RSA-SECURID - Certificate - KCD - RADIUS and LDAP-Unencrypted - RADIUS and LDAP-StartTLS - RADIUS and LDAP-LDAPS String max_failed_auths The maximum number of failed login attempts before the user is locked out. Range: 0 – 999 0 = Never lock out Int32 reset_fail_tout The time that must elapse before the max_failed_auths counter is reset to 0. This must be less than the unblocktout value. This parameter is only relevant if the max_failed_auths parameter is set to a value greater than 0. Range: 60-86400 Int32 unblock_tout The timeout in seconds before a blocked account is automatically unblocked again. This must be greater than the reset_fail_tout parameter value. Range: 60-86400 Int32 logon_fmt Specify the logon string format used to authenticate to the LDAP/RADIUS server. The Username%20only value is only available if the auth_type is set to a RADIUS or RSA-SecurID protocol. The Username value is not available if the auth_type is set to RADIUS or a RADIUS and LDAP protocol. String logon_fmt2 Specify the logon string format used to authenticate to the server. String logon_domain The login domain to be used. This is also used with the logon format to construct the normalized username, for example: - Principalname: <username>@<domain> - Username: <domain>\<username> String sess_tout_type Specify the type of session timeout to be used: - idle time - max duration String sess_tout_idle_pub The session idle timeout value in seconds. This value is used in a public environment. Range: 60-68400 Int32 sess_tout_duration_pub The maximum duration timeout value for the session in seconds. This value is used in a public environment. Range: 60-86400 Int32 sess_tout_idle_priv The session idle timeout value in seconds. This value is used in a private environment. Range: 60-68400 Int32 sess_tout_duration_priv The maximum duration timeout value for the session in seconds. This value is used in a private environment. Range: 60-86400 Int32 testuser The username that will be used to check the authentication server(s), if you are not using an LDAP endpoint. String testpass The password of the user that will be used to check the authentication server(s), if you are not using an LDAP endpoint. String radius_shared_secret The shared secret to be used between the radius server and the LoadMaster. String kerberos_domain The name of the Kerberos realm. String kerberos_kdc The name of the Kerberos Key Distribution Center (KDC). String kcd_username The username of the Kerberos trusted user. String kcd_password The password of the Kerberos trusted user. String server_side Specify if this is an outbound KCD SSO domain or not. y – KCD n – Not KCD String cert_check_asi This option is only available when the authtype is set to Certificate. When this option is enabled - in addition to checking the validity of the client certificate, the client certificate will also be checked against the altSecurityIdentities (ASI) attribute of the user on the Active Directory. String cert_check_cn Enabling this parameter allows a fallback to check the Common Name (CN) in the certificate when the SAN is not available. String Logon_Transcode Enable or disable the transcode of logon credentials from ISO-8859-1 to UTF-8, when required. 0 - Disable 1 - Enable Boolean ldap_endpoint Specify the name of an existing LDAP endpoint to use. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String Domain Specifies the name of the SSO domain LoadMaster entry to be modified. String String TLS Specifies the encryption to use for authentication. This parameter accepts "Unencrypted", "StartTLS", and "LDAPS". String String Server Specifies the server(s) to authenticate against. String[] String[] Server2 When using dual factor authentication, use the server parameter to set the address of the RADIUS server(s) and use the server2 parameter to set the address of the LDAP server(s). String[] String[] auth_type Specify the transport protocol used to communicate with the authentication server. Possible values are: - LDAP-Unencrypted - LDAP-StartTLS - LDAP-LDAPS - RADIUS - RSA-SECURID - Certificate - KCD - RADIUS and LDAP-Unencrypted - RADIUS and LDAP-StartTLS - RADIUS and LDAP-LDAPS String String max_failed_auths The maximum number of failed login attempts before the user is locked out. Range: 0 – 999 0 = Never lock out Int32 Int32 reset_fail_tout The time that must elapse before the max_failed_auths counter is reset to 0. This must be less than the unblocktout value. This parameter is only relevant if the max_failed_auths parameter is set to a value greater than 0. Range: 60-86400 Int32 Int32 unblock_tout The timeout in seconds before a blocked account is automatically unblocked again. This must be greater than the reset_fail_tout parameter value. Range: 60-86400 Int32 Int32 logon_fmt Specify the logon string format used to authenticate to the LDAP/RADIUS server. The Username%20only value is only available if the auth_type is set to a RADIUS or RSA-SecurID protocol. The Username value is not available if the auth_type is set to RADIUS or a RADIUS and LDAP protocol. String String logon_fmt2 Specify the logon string format used to authenticate to the server. String String logon_domain The login domain to be used. This is also used with the logon format to construct the normalized username, for example: - Principalname: <username>@<domain> - Username: <domain>\<username> String String sess_tout_type Specify the type of session timeout to be used: - idle time - max duration String String sess_tout_idle_pub The session idle timeout value in seconds. This value is used in a public environment. Range: 60-68400 Int32 Int32 sess_tout_duration_pub The maximum duration timeout value for the session in seconds. This value is used in a public environment. Range: 60-86400 Int32 Int32 sess_tout_idle_priv The session idle timeout value in seconds. This value is used in a private environment. Range: 60-68400 Int32 Int32 sess_tout_duration_priv The maximum duration timeout value for the session in seconds. This value is used in a private environment. Range: 60-86400 Int32 Int32 testuser The username that will be used to check the authentication server(s), if you are not using an LDAP endpoint. String String testpass The password of the user that will be used to check the authentication server(s), if you are not using an LDAP endpoint. String String radius_shared_secret The shared secret to be used between the radius server and the LoadMaster. String String kerberos_domain The name of the Kerberos realm. String String kerberos_kdc The name of the Kerberos Key Distribution Center (KDC). String String kcd_username The username of the Kerberos trusted user. String String kcd_password The password of the Kerberos trusted user. String String server_side Specify if this is an outbound KCD SSO domain or not. y – KCD n – Not KCD String String cert_check_asi This option is only available when the authtype is set to Certificate. When this option is enabled - in addition to checking the validity of the client certificate, the client certificate will also be checked against the altSecurityIdentities (ASI) attribute of the user on the Active Directory. String String cert_check_cn Enabling this parameter allows a fallback to check the Common Name (CN) in the certificate when the SAN is not available. String String Logon_Transcode Enable or disable the transcode of logon credentials from ISO-8859-1 to UTF-8, when required. 0 - Disable 1 - Enable Boolean Boolean ldap_endpoint Specify the name of an existing LDAP endpoint to use. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String DomainObject Accepts a custom object that has the Domain, TLS, and Server properties to add to the load balancer. Can be used to import a CSV file of entries to the load balancer. psobject[] psobject[] ldap_admin The LDAP administrator username. This is only relevant when the authtype is set to Certificate. string string ldap_password The LDAP administrator password. This is only relevant when the authtype is set to Certificate. string string logonfmt Specify the logon string format used to authenticate to the server. Possible values are: - Notspecified - Principalname - Username - Usernameonly The Username value is not available if the auth_type is set to RADIUS or a RADIUS and LDAP protocol. string string logonfmt2 Specify the logon string format used to authenticate to the server. - Notspecified - Principalname - Username string string You can only use one login method - either certificate or credential. You cannot use both. -------------------------- Example -------------------------- PS C:\> Set-SSODomain -server 10.154.45.22 -Domain example3.com Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Param........: @{Id=9; Name=EXAMPLE2.COM; server=10.154.45.22; testuser=; ldap_version=3; server_side=0; auth_type=RSA-SECURID; logon_fmt=Principalname; logon_fmt2=Principalname; logon_transcode=1; logon_domain=; idp_entity_id=; idp_sso_url=; idp_logoff_url=; idp_cert=; sp_entity_id=; sp_cert=UseSelfSig ned; kerberos_domain=; kerberos_kdc=; kcd_username=; max_failed_auths=0; reset_fail_tout=60; unblock_tout=1800; sess_tout_type=idle time; sess_tout_idle _pub=900; sess_tout_duration_pub=1800; sess_tout_idle_priv=900; sess_tout_duration_priv=28800; cert_check_asi=0; cert_check_cn=0} Id : 9 Name : EXAMPLE2.COM server : 10.154.45.22 testuser : ldap_version : 3 server_side : 0 auth_type : RSA-SECURID logon_fmt : Principalname logon_fmt2 : Principalname logon_transcode : 1 logon_domain : idp_entity_id : idp_sso_url : idp_logoff_url : idp_cert : sp_entity_id : sp_cert : UseSelfSigned kerberos_domain : kerberos_kdc : kcd_username : max_failed_auths : 0 reset_fail_tout : 60 unblock_tout : 1800 sess_tout_type : idle time sess_tout_idle_pub : 900 sess_tout_duration_pub : 1800 sess_tout_idle_priv : 900 sess_tout_duration_priv : 28800 cert_check_asi : 0 cert_check_cn : 0 Set-SSODomainUnlockUser Allows you to unblock users who are currently blocked from accessing the SSO domain. Set SSODomainUnlockUser Allows you to unblock users who are currently blocked from accessing the SSO domain. Set-SSODomainUnlockUser Domain The name of the SSO domain. String Users The username of the user to be unblocked. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Set-SSODomainUnlockUser Domain The name of the SSO domain. String Users The username of the user to be unblocked. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String Domain The name of the SSO domain. String String Users The username of the user to be unblocked. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Set-SSODomainUnlockUser -Domain example2.com -Users test Example Output: Return Code..: 200 Response.....: Command successfully executed. Data field...: UnlockedUsers ------------- @{user=test} Set-SyslogOption WARNING: This function is deprecated. Use the following command instead: Set-LogSyslogConfiguration Set SyslogOption WARNING: This function is deprecated. Use the following command instead: Set-LogSyslogConfiguration Set-SyslogOption SyslogCritical String SyslogEmergency String SyslogError String SyslogInfo String SyslogNotice String SyslogWarn String SyslogPort UInt16 LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String Set-SyslogOption SyslogCritical String SyslogEmergency String SyslogError String SyslogInfo String SyslogNotice String SyslogWarn String SyslogPort UInt16 LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String SyslogCritical String String SyslogEmergency String String SyslogError String String SyslogInfo String String SyslogNotice String String SyslogWarn String String SyslogPort UInt16 UInt16 LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String Set-TlsCipherSet Create or modify a custom cipher set. Set TlsCipherSet Updates an existing custom cipher set or creates a new custom cipher set. If the name of an existing custom cipher set is used, that cipher set will be updated. If a new name is used, a new cipher set will be created. Set-TlsCipherSet Name The name of the custom cipher set. String Value A colon (:) separated list of ciphers to assign to the set. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Set-TlsCipherSet Name The name of the custom cipher set. String Value A colon (:) separated list of ciphers to assign to the set. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String Name The name of the custom cipher set. String String Value A colon (:) separated list of ciphers to assign to the set. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String If the name of an existing custom cipher set is specified, that cipher set will be updated. If a new name is used, a new cipher set will be created. -------------------------- Example -------------------------- PS C:\> Set-TlsCipherSet -Name ExampleCipherSet -Value ECDHE-RSA-AES256-SHA384:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES256-SHA Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Set-TlsHSM Allows you to configure the HSM settings. Set TlsHSM Allows you to configure the HSM settings. Set-TlsHSM Sethsm To set the HSM sub-system to Safenet Luna HSM use LunaCA3. To set the HSM sub-system to Cavium HSM use cavhsm. These parameters are case sensitive. String Safeaddr Specify the address of the Safenet HSM unit to be used. String Clpass Specify the password for the partition on the HSM so that the LoadMaster can access the HSM. String Enable Enable or disable Safenet HSM: 0 – Disabled 1 – Enabled Boolean Cavhsmaddr Specify the address of the Cavium HSM unit to be used. String Cavhsmpasswd The password for the HSM partition. The HSM partition password would have been set on the HSM when originally configuring the partition. For further information, please consult the HSM vendor documentation. String Cavhsmuser The username for the HSM partition. String Cavhsmenable Enable Cavium HSM: 0 - Disable 1 - Enable Boolean LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Set-TlsHSM Sethsm To set the HSM sub-system to Safenet Luna HSM use LunaCA3. To set the HSM sub-system to Cavium HSM use cavhsm. These parameters are case sensitive. String Safeaddr Specify the address of the Safenet HSM unit to be used. String Clpass Specify the password for the partition on the HSM so that the LoadMaster can access the HSM. String Enable Enable or disable Safenet HSM: 0 – Disabled 1 – Enabled Boolean Cavhsmaddr Specify the address of the Cavium HSM unit to be used. String Cavhsmpasswd The password for the HSM partition. The HSM partition password would have been set on the HSM when originally configuring the partition. For further information, please consult the HSM vendor documentation. String Cavhsmuser The username for the HSM partition. String Cavhsmenable Enable Cavium HSM: 0 - Disable 1 - Enable Boolean LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String Sethsm To set the HSM sub-system to Safenet Luna HSM use LunaCA3. To set the HSM sub-system to Cavium HSM use cavhsm. These parameters are case sensitive. String String Safeaddr Specify the address of the Safenet HSM unit to be used. String String Clpass Specify the password for the partition on the HSM so that the LoadMaster can access the HSM. String String Enable Enable or disable Safenet HSM: 0 – Disabled 1 – Enabled Boolean Boolean Cavhsmaddr Specify the address of the Cavium HSM unit to be used. String String Cavhsmpasswd The password for the HSM partition. The HSM partition password would have been set on the HSM when originally configuring the partition. For further information, please consult the HSM vendor documentation. String String Cavhsmuser The username for the HSM partition. String String Cavhsmenable Enable Cavium HSM: 0 - Disable 1 - Enable Boolean Boolean LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String Starting the HSM may take some time. Disabling the HSM means the LoadMaster is unable to create new SSL (HTTPS) connections and immediately drops existing connections until another HSM is added or the certificate configuration is changed. It is strongly recommended to only change the HSM configuration when there are no active SSL connections. -------------------------- Example -------------------------- PS C:\> Set-TlsHSM -Cavhsmaddr 10.154.22.44 Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Data field...: @{engine=cavhsm; addr=10.154.22.44; user=ExampleUser; enable=0} cavhsm 10.154.22.44 ExampleUser 0 Set-VirtualService WARNING: This function is deprecated. Use the following command instead: Set-AdcVirtualService Set VirtualService WARNING: This function is deprecated. Use the following command instead: Set-AdcVirtualService Set-VirtualService VirtualService String VSPort Int32 VSProtocol String VSIndex Int32 AddVia Int16 Cache Boolean CertFile String CheckType String CheckHost String CheckPattern String CheckUrl String CheckHeaders String LdapEndpoint String MatchLen String CheckUse1_1 Int32 CheckPort Int32 EnhancedHealthChecks Boolean RsMinimum Int32 ClientCert Int16 Compress Boolean Cookie String CachePercent Int16 DefaultGW String Enable Boolean ErrorCode String ErrorUrl String PortFollow Int32 ForceL7 Boolean Idletime Int32 LocalBindAddresses String[] VSType String Nickname String Persist String PersistTimeout Int32 QueryTag String CipherSet String SSLReencrypt Boolean SSLReverse Boolean SSLRewrite String ReverseSNIHostname String Schedule String ServerInit Int16 SSLAcceleration Boolean StandByAddr String StandByPort String TransactionLimit Int32 Transparent Boolean SubnetOriginating Boolean UseforSnat Boolean QoS String CheckUseGet Int32 Verify Int16 ExtraHdrKey String ExtraHdrValue String AllowedHosts String AllowedDirectories String AllowedGroups String GroupSIDs String IncludeNestedGroups Boolean DisplayPubPriv Boolean DisablePasswordForm Boolean Domain String AltDomains String Logoff String ESPLogs Int16 SMTPAllowedDomains String ESPEnabled Boolean UserPwdChangeUrl String UserPwdChangeMsg String InputAuthMode Int16 OutputAuthMode Int16 StartTLSMode Int16 ExtraPorts String AltAddress String MultiConnect Boolean SingleSignOnDir String OCSPVerify String FollowVSID Int32 TlsType Boolean CheckPostData String CheckCodes String PreProcPrecedence String PreProcPrecedencePos Int16 RequestPrecedence String RequestPrecedencePos Int16 ResponsePrecedence String ResponsePrecedencePos Int16 RsRulePrecedence String RsRulePrecedencePos Int16 NeedHostName Boolean CopyHdrFrom String CopyHdrTo String ServerFbaPath String ServerFbaPost String Intercept Boolean AllowHTTP2 Boolean InterceptOpts String InterceptRules String AlertThreshold Int32 LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String Set-VirtualService VirtualService String VSPort Int32 VSProtocol String VSIndex Int32 AddVia Int16 Cache Boolean CertFile String CheckType String CheckHost String CheckPattern String CheckUrl String CheckHeaders String LdapEndpoint String MatchLen String CheckUse1_1 Int32 CheckPort Int32 EnhancedHealthChecks Boolean RsMinimum Int32 ClientCert Int16 Compress Boolean Cookie String CachePercent Int16 DefaultGW String Enable Boolean ErrorCode String ErrorUrl String PortFollow Int32 ForceL7 Boolean Idletime Int32 LocalBindAddresses String[] VSType String Nickname String Persist String PersistTimeout Int32 QueryTag String CipherSet String SSLReencrypt Boolean SSLReverse Boolean SSLRewrite String ReverseSNIHostname String Schedule String ServerInit Int16 SSLAcceleration Boolean StandByAddr String StandByPort String TransactionLimit Int32 Transparent Boolean SubnetOriginating Boolean UseforSnat Boolean QoS String CheckUseGet Int32 Verify Int16 ExtraHdrKey String ExtraHdrValue String AllowedHosts String AllowedDirectories String AllowedGroups String GroupSIDs String IncludeNestedGroups Boolean DisplayPubPriv Boolean DisablePasswordForm Boolean Domain String AltDomains String Logoff String ESPLogs Int16 SMTPAllowedDomains String ESPEnabled Boolean UserPwdChangeUrl String UserPwdChangeMsg String InputAuthMode Int16 OutputAuthMode Int16 StartTLSMode Int16 ExtraPorts String AltAddress String MultiConnect Boolean SingleSignOnDir String OCSPVerify String FollowVSID Int32 TlsType Boolean CheckPostData String CheckCodes String PreProcPrecedence String PreProcPrecedencePos Int16 RequestPrecedence String RequestPrecedencePos Int16 ResponsePrecedence String ResponsePrecedencePos Int16 RsRulePrecedence String RsRulePrecedencePos Int16 NeedHostName Boolean CopyHdrFrom String CopyHdrTo String ServerFbaPath String ServerFbaPost String Intercept Boolean AllowHTTP2 Boolean InterceptOpts String InterceptRules String AlertThreshold Int32 LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String VirtualService String String VSPort Int32 Int32 VSProtocol String String VSIndex Int32 Int32 AddVia Int16 Int16 Cache Boolean Boolean CertFile String String CheckType String String CheckHost String String CheckPattern String String CheckUrl String String CheckHeaders String String LdapEndpoint String String MatchLen String String CheckUse1_1 Int32 Int32 CheckPort Int32 Int32 EnhancedHealthChecks Boolean Boolean RsMinimum Int32 Int32 ClientCert Int16 Int16 Compress Boolean Boolean Cookie String String CachePercent Int16 Int16 DefaultGW String String Enable Boolean Boolean ErrorCode String String ErrorUrl String String PortFollow Int32 Int32 ForceL7 Boolean Boolean Idletime Int32 Int32 LocalBindAddresses String[] String[] VSType String String Nickname String String Persist String String PersistTimeout Int32 Int32 QueryTag String String CipherSet String String SSLReencrypt Boolean Boolean SSLReverse Boolean Boolean SSLRewrite String String ReverseSNIHostname String String Schedule String String ServerInit Int16 Int16 SSLAcceleration Boolean Boolean StandByAddr String String StandByPort String String TransactionLimit Int32 Int32 Transparent Boolean Boolean SubnetOriginating Boolean Boolean UseforSnat Boolean Boolean QoS String String CheckUseGet Int32 Int32 Verify Int16 Int16 ExtraHdrKey String String ExtraHdrValue String String AllowedHosts String String AllowedDirectories String String AllowedGroups String String GroupSIDs String String IncludeNestedGroups Boolean Boolean DisplayPubPriv Boolean Boolean DisablePasswordForm Boolean Boolean Domain String String AltDomains String String Logoff String String ESPLogs Int16 Int16 SMTPAllowedDomains String String ESPEnabled Boolean Boolean UserPwdChangeUrl String String UserPwdChangeMsg String String InputAuthMode Int16 Int16 OutputAuthMode Int16 Int16 StartTLSMode Int16 Int16 ExtraPorts String String AltAddress String String MultiConnect Boolean Boolean SingleSignOnDir String String OCSPVerify String String FollowVSID Int32 Int32 TlsType Boolean Boolean CheckPostData String String CheckCodes String String PreProcPrecedence String String PreProcPrecedencePos Int16 Int16 RequestPrecedence String String RequestPrecedencePos Int16 Int16 ResponsePrecedence String String ResponsePrecedencePos Int16 Int16 RsRulePrecedence String String RsRulePrecedencePos Int16 Int16 NeedHostName Boolean Boolean CopyHdrFrom String String CopyHdrTo String String ServerFbaPath String String ServerFbaPost String String Intercept Boolean Boolean AllowHTTP2 Boolean Boolean InterceptOpts String String InterceptRules String String AlertThreshold Int32 Int32 LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String SetVpnAddrs WARNING: This function is deprecated. Use the following command instead: Set-LmVpnAddrs WARNING: This function is deprecated. Use the following command instead: Set-LmVpnAddrs SetVpnAddrs Name String LocalIp String LocalSubnets String RemoteIp String RemoteSubnets String LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String SetVpnAddrs Name String LocalIp String LocalSubnets String RemoteIp String RemoteSubnets String LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String Name String String LocalIp String String LocalSubnets String String RemoteIp String String RemoteSubnets String String LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String SetVpnLocalIp WARNING: This function is deprecated. Use the following command instead: Set-LmVpnLocalIp WARNING: This function is deprecated. Use the following command instead: Set-LmVpnLocalIp SetVpnLocalIp Name String LocalIp String LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String SetVpnLocalIp Name String LocalIp String LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String Name String String LocalIp String String LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String SetVpnLocalSubnets WARNING: This function is deprecated. Use the following command instead: Set-LmVpnLocalSubnet WARNING: This function is deprecated. Use the following command instead: Set-LmVpnLocalSubnet SetVpnLocalSubnets Name String LocalSubnets String LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String SetVpnLocalSubnets Name String LocalSubnets String LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String Name String String LocalSubnets String String LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String SetVpnPfsDisable WARNING: This function is deprecated. Use the following command instead: Set-LmVpnPfsDisable WARNING: This function is deprecated. Use the following command instead: Set-LmVpnPfsDisable SetVpnPfsDisable Name String LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String SetVpnPfsDisable Name String LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String Name String String LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String SetVpnPfsEnable WARNING: This function is deprecated. Use the following command instead: Set-LmVpnPfsEnable WARNING: This function is deprecated. Use the following command instead: Set-LmVpnPfsEnable SetVpnPfsEnable Name String LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String SetVpnPfsEnable Name String LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String Name String String LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String SetVpnRemoteIp WARNING: This function is deprecated. Use the following command instead: Set-LmVpnRemoteIp WARNING: This function is deprecated. Use the following command instead: Set-LmVpnRemoteIp SetVpnRemoteIp Name String RemoteIp String LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String SetVpnRemoteIp Name String RemoteIp String LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String Name String String RemoteIp String String LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String SetVpnRemoteSubnets WARNING: This function is deprecated. Use the following command instead: Set-LmVpnRemoteSubnet WARNING: This function is deprecated. Use the following command instead: Set-LmVpnRemoteSubnet SetVpnRemoteSubnets Name String RemoteSubnets String LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String SetVpnRemoteSubnets Name String RemoteSubnets String LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String Name String String RemoteSubnets String String LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String SetVpnSecret WARNING: This function is deprecated. Use the following command instead: Set-LmVpnSecret WARNING: This function is deprecated. Use the following command instead: Set-LmVpnSecret SetVpnSecret Name String LocalId String RemoteId String Key String LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String SetVpnSecret Name String LocalId String RemoteId String Key String LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String Name String String LocalId String String RemoteId String String Key String String LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String Set-WafLogFormat Configure the format of the WAF logs. Set WafLogFormat The WAF logs can either be in JSON or native format. Set-WafLogFormat LogFormat Specify the format of the WAF log. This can be either in JSON or native format. Valid values are: - json - native String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Set-WafLogFormat LogFormat Specify the format of the WAF log. This can be either in JSON or native format. Valid values are: - json - native String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String LogFormat Specify the format of the WAF log. This can be either in JSON or native format. Valid values are: - json - native String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Set-WafLogFormat -LogFormat json Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Set-WafRulesAutoUpdateConfiguration Configure the Web Application Firewall (WAF) auto-update settings. Set WafRulesAutoUpdateConfiguration This command can be used to set the WAF auto-update settings. Set-WafRulesAutoUpdateConfiguration DatabaseAutoUpdate Enable or disable the automatic downloading of updates to the commercial WAF rule files. When this option is enabled, updated rules are downloaded on a daily basis from KEMP. The installation time for these rule updates is 4am. SwitchParameter LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String Set-WafRulesAutoUpdateConfiguration DatabaseAutoInstall Enable or disable the automatic installation of updated commercial rule files. SwitchParameter DatabaseInstallTimeHour Set the time of day that the commercial rule files will be automatically installed. The hour is the hour value from the 24-hour clock (0-23), for example 13 is 1pm. The range is 0-23. Minutes cannot be specified. Int32 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String DatabaseAutoUpdate Enable or disable the automatic downloading of updates to the commercial WAF rule files. When this option is enabled, updated rules are downloaded on a daily basis from KEMP. The installation time for these rule updates is 4am. SwitchParameter SwitchParameter LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String InformationAction ActionPreference ActionPreference InformationVariable String String DatabaseAutoInstall Enable or disable the automatic installation of updated commercial rule files. SwitchParameter SwitchParameter DatabaseInstallTimeHour Set the time of day that the commercial rule files will be automatically installed. The hour is the hour value from the 24-hour clock (0-23), for example 13 is 1pm. The range is 0-23. Minutes cannot be specified. Int32 Int32 You can only use one login method - either certificate or credential. You cannot use both. -------------------------- Example -------------------------- PS C:\> Set-WafRulesAutoUpdateConfiguration -DatabaseInstallTimeHour 3 Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed; Data=} Return Code..: 200 Response.....: Command successfully executed Set-WUIAuth WARNING: This function is deprecated. Use the following command instead: Set-SecWuiAuthentication Set WUIAuth WARNING: This function is deprecated. Use the following command instead: Set-SecWuiAuthentication Set-WUIAuth RADIUSServer String RADIUSPort Int64 RADIUSSecret String RADIUSBackupServer String RADIUSBackupPort Int64 RADIUSBackupSecret String RADIUSRevalidateInterval Int32 WuiLdapEp String SessionLocalAuth Boolean SessionAuthMode Int16 LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String Set-WUIAuth RADIUSServer String RADIUSPort Int64 RADIUSSecret String RADIUSBackupServer String RADIUSBackupPort Int64 RADIUSBackupSecret String RADIUSRevalidateInterval Int32 WuiLdapEp String SessionLocalAuth Boolean SessionAuthMode Int16 LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String RADIUSServer String String RADIUSPort Int64 Int64 RADIUSSecret String String RADIUSBackupServer String String RADIUSBackupPort Int64 Int64 RADIUSBackupSecret String String RADIUSRevalidateInterval Int32 Int32 WuiLdapEp String String SessionLocalAuth Boolean Boolean SessionAuthMode Int16 Int16 LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String Set-WUISetting WARNING: This function is deprecated. Use the following command instead: Set-SecAdminWuiConfiguration Set WUISetting WARNING: This function is deprecated. Use the following command instead: Set-SecAdminWuiConfiguration Set-WUISetting WUITLSProtocols Int32 WUICipherset String sessioncontrol Boolean sessionbasicauth Boolean sessionmaxfailattempts Int16 sessionidletime Int32 sessionconcurrent Int16 wuipreauth String LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String Set-WUISetting WUITLSProtocols Int32 WUICipherset String sessioncontrol Boolean sessionbasicauth Boolean sessionmaxfailattempts Int16 sessionidletime Int32 sessionconcurrent Int16 wuipreauth String LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String WUITLSProtocols Int32 Int32 WUICipherset String String sessioncontrol Boolean Boolean sessionbasicauth Boolean Boolean sessionmaxfailattempts Int16 Int16 sessionidletime Int32 Int32 sessionconcurrent Int16 Int16 wuipreauth String String LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String ShowCluster WARNING: This function is deprecated. Use the following command instead: Get-GeoCluster WARNING: This function is deprecated. Use the following command instead: Get-GeoCluster ShowCluster ClusterIp String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String ShowCluster ClusterIp String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String ClusterIp String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String IP The IP address of the cluster. string string -------------------------- Example -------------------------- PS C:\> ShowCluster –IP <IPAddress> Example Output: Enable : Y LocationLatitude : 0.00000000 Type : localLM LocationLongitude : 0.00000000 ClusterVSAddress : Checker : none Name : local_Cluster Index : 1 Status : Up CheckerPort : 0 IPAddress : 10.11.0.105 ShowIP WARNING: This function is deprecated. Use the following command instead: Get-GeoIpRange WARNING: This function is deprecated. Use the following command instead: Get-GeoIpRange ShowIP IP IP address of the IP range. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String ShowIP IP IP address of the IP range. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String IP IP address of the IP range. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String -------------------------- Example -------------------------- PS C:\> ShowIP –IP <IPAddress> Example Output: countrycode : IE Ip : 10.11.0.65 Used : Y IsCustom : N Mask : 24 Index : 2 CustomLocation : 0 IPAddress : 10.11.0.65 StartIkeDaemon WARNING: This function is deprecated. Use the following command instead: Start-LmVpnIkeDaemon WARNING: This function is deprecated. Use the following command instead: Start-LmVpnIkeDaemon StartIkeDaemon LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String StartIkeDaemon LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String Start-LmVpnConnection Start the Virtual Private Network (VPN) Start LmVpnConnection This command allows you to start the connection of specified VPN. Start-LmVpnConnection Name The name of the VPN. String LoadBalancer The IP address of the KEMP LoadMaster that you are directing the command to. This can be set globally by using the Initialize-LoadBalancer command, but can be overridden on each individual command by using this parameter. String LBPort The port of the load balancer. Int32 Credential Specifies a user account that has permission to administer the load balancer. You can either enter a username for the load balancer or provide a PSCredential object, such as an object that is returned by the Get-Credential cmdlet. When you type a username, you are prompted for a password. Object InformationAction ActionPreference InformationVariable String Start-LmVpnConnection Name The name of the VPN. String LoadBalancer The IP address of the KEMP LoadMaster that you are directing the command to. This can be set globally by using the Initialize-LoadBalancer command, but can be overridden on each individual command by using this parameter. String LBPort The port of the load balancer. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. String InformationAction ActionPreference InformationVariable String Name The name of the VPN. String String LoadBalancer The IP address of the KEMP LoadMaster that you are directing the command to. This can be set globally by using the Initialize-LoadBalancer command, but can be overridden on each individual command by using this parameter. String String LBPort The port of the load balancer. Int32 Int32 Credential Specifies a user account that has permission to administer the load balancer. You can either enter a username for the load balancer or provide a PSCredential object, such as an object that is returned by the Get-Credential cmdlet. When you type a username, you are prompted for a password. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. String String -------------------------- Example -------------------------- PS C:\> Start-LmVpnConnection -Name ExampleVPN Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Start-LmVpnIkeDaemon Starts the Internet Key Exchange (IKE) daemon. Start LmVpnIkeDaemon Run this command to start the IKE daemon. Start-LmVpnIkeDaemon LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Start-LmVpnIkeDaemon LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Start-LmVpnIkeDaemon Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. StartVpnConnection WARNING: This function is deprecated. Use the following command instead: Start-LmVpnConnection WARNING: This function is deprecated. Use the following command instead: Start-LmVpnConnection StartVpnConnection Name String LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String StartVpnConnection Name String LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String Name String String LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String StatusIkeDaemon WARNING: This function is deprecated. Use the following command instead: Get-LmVpnIkeDaemonStatus WARNING: This function is deprecated. Use the following command instead: Get-LmVpnIkeDaemonStatus StatusIkeDaemon LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String StatusIkeDaemon LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String Stop-AslInstance If the Activation Server functionality was used to license the LoadMaster, this command can be used to deactivate the client LoadMaster license. Stop AslInstance KEMP strongly recommends deregistering a LoadMaster using the KEMP 360 Central User Interface (UI) or the KEMP 360 Central API, rather than the LoadMaster ones. Deregistering a LoadMaster from the LoadMaster UI can lead to the LoadMaster having an unknown state in KEMP 360 Central. In these cases, it is not easy to remove the LoadMaster from KEMP 360 Central and the unknown LoadMaster is still taking up an available license. Stop-AslInstance LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Stop-AslInstance LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Stop-AslInstance Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. StopIkeDaemon WARNING: This function is deprecated. Use the following command instead: Stop-LmVpnIkeDaemon WARNING: This function is deprecated. Use the following command instead: Stop-LmVpnIkeDaemon StopIkeDaemon LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String StopIkeDaemon LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String Stop-LmVpnConnection Stop the Virtual Private Network (VPN). Stop LmVpnConnection This command allows you to stop the connection of specified VPN. Stop-LmVpnConnection Name The name of the VPN. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Stop-LmVpnConnection Name The name of the VPN. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String Name The name of the VPN. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Stop-LmVpnConnection -Name ExampleVPN Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Stop-LmVpnIkeDaemon Stop the Internet Key Exchange (IKE) daemon. Stop LmVpnIkeDaemon This command allows you to stop the IKE daemon. Stop-LmVpnIkeDaemon LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Stop-LmVpnIkeDaemon LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Stop-LmVpnIkeDaemon Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Stop-SSODomainSession Kill all open sessions for an SSO domain, or one particular session. Stop SSODomainSession Kill all open sessions for an SSO domain, or one particular session. Stop-SSODomainSession Domain Specify the domain to kill the open sessions for. String Key To kill all open sessions for the specified domain, leave this parameter blank. To kill a particular session, specify the cookie or <Username>,<HostIPAddress>. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Stop-SSODomainSession Domain Specify the domain to kill the open sessions for. String Key To kill all open sessions for the specified domain, leave this parameter blank. To kill a particular session, specify the cookie or <Username>,<HostIPAddress>. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String Domain Specify the domain to kill the open sessions for. String String Key To kill all open sessions for the specified domain, leave this parameter blank. To kill a particular session, specify the cookie or <Username>,<HostIPAddress>. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Stop-SSODomainSession -Domain qasp.com Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. StopVpnConnection WARNING: This function is deprecated. Use the following command instead: Stop-LmVpnConnection WARNING: This function is deprecated. Use the following command instead: Stop-LmVpnConnection StopVpnConnection Name String LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String StopVpnConnection Name String LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String Name String String LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String Test-LmGeoEnabled Will tell you if GEO is currently enabled or disabled. Test LmGeoEnabled Will tell you if GEO is currently enabled or disabled. Test-LmGeoEnabled LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Test-LmGeoEnabled LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Test-LmGeoEnabled Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. GEO is disabled Test-LmServerConnection Test the connection to the LoadMaster. Test LmServerConnection Test the connection to the LoadMaster. Test-LmServerConnection ComputerName Enter the LoadMaster IP address. String Port Enter the Port to perform the test on. Int32 InformationAction ActionPreference InformationVariable String ComputerName Enter the LoadMaster IP address. String String Port Enter the Port to perform the test on. Int32 Int32 InformationAction ActionPreference ActionPreference InformationVariable String String -------------------------- Example -------------------------- PS C:\> Test-LmServerConnection -ComputerName 172.20.1.19 -Port 443 Example Output: True Test-NetworkRoute Run a traceroute. Test NetworkRoute This diagnostic utility determines the route to a destination by sending Internet Control Message Protocol (ICMP) echo packets to the destination. Test-NetworkRoute Address The address to run the command on. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Test-NetworkRoute Address The address to run the command on. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String Address The address to run the command on. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Test-NetworkRoute -Address 10.154.11.23 Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Data field...: @{Traceroute=} TracerouteTo : traceroute to 10.154.11.23 (10.154.11.23), 30 hops max, 60 byte packets Hop 1 : 1 10.154.11.180 3007.251 ms !H 3007.028 ms !H 3006.995 ms !H Test-SecAPIAccess This command will tell you if the API interface is enabled or disabled on the LoadMaster. Test SecAPIAccess This command will tell you if the API interface is enabled or disabled on the LoadMaster. Test-SecAPIAccess LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Test-SecAPIAccess LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Test-SecApiAccess Example Output: Full response: @{ReturnCode=200; Response=The API is enabled; Data=} Return Code..: 200 Response.....: The API is enabled 7.2.39.0.14993.DEV Test-ServerConnection WARNING: This function is deprecated. Use the following command instead: Test-LmServerConnection Test ServerConnection WARNING: This function is deprecated. Use the following command instead: Test-LmServerConnection Test-ServerConnection ComputerName String Port Int32 InformationAction ActionPreference InformationVariable String ComputerName String String Port Int32 Int32 InformationAction ActionPreference ActionPreference InformationVariable String String Trace-TcpTraffic Executes the tcpdump command. Trace TcpTraffic Run a tcpdump. The tcpdump captures until the packet limit or time limit is reached (whatever is first) and returns the tcpdump as a pcap binary. Mime type: <application/cap> Trace-TcpTraffic MaxPackets The maximum number of packets to capture. The default value for this parameter is 10000. Valid values range from 1 to 200000. The maximum is the API maximum - the actual maximum size is defined by the space available. Int32 MaxTime The maximum number of seconds to capture. The default value for this parameter is 10. Valid values range from 1 to 600. Int32 Interface The interface(s) to monitor. The default interface is eth0. A TCP dump can be captured either by one or all Ethernet ports. String Port The port to monitor. String Address The (optional) address to monitor. String TcpOptions Any optional parameters needed. The maximum number of characters permitted is 255. String Path The path to and filename of an export of the tcpdump results. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Force Enable this parameter to force the command to execute without a confirmation. SwitchParameter InformationAction ActionPreference InformationVariable String WhatIf Enable this parameter to see what the command will do without actually executing the command. SwitchParameter Confirm Confirms that the action should be carried out. SwitchParameter Trace-TcpTraffic MaxPackets The maximum number of packets to capture. The default value for this parameter is 10000. Valid values range from 1 to 200000. The maximum is the API maximum - the actual maximum size is defined by the space available. Int32 MaxTime The maximum number of seconds to capture. The default value for this parameter is 10. Valid values range from 1 to 600. Int32 Interface The interface(s) to monitor. The default interface is eth0. A TCP dump can be captured either by one or all Ethernet ports. String Port The port to monitor. String Address The (optional) address to monitor. String TcpOptions Any optional parameters needed. The maximum number of characters permitted is 255. String Path The path to and filename of an export of the tcpdump results. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String Force Enable this parameter to force the command to execute without a confirmation. SwitchParameter InformationAction ActionPreference InformationVariable String WhatIf Enable this parameter to see what the command will do without actually executing the command. SwitchParameter Confirm Confirms that the action should be carried out. SwitchParameter MaxPackets The maximum number of packets to capture. The default value for this parameter is 10000. Valid values range from 1 to 200000. The maximum is the API maximum - the actual maximum size is defined by the space available. Int32 Int32 MaxTime The maximum number of seconds to capture. The default value for this parameter is 10. Valid values range from 1 to 600. Int32 Int32 Interface The interface(s) to monitor. The default interface is eth0. A TCP dump can be captured either by one or all Ethernet ports. String String Port The port to monitor. String String Address The (optional) address to monitor. String String TcpOptions Any optional parameters needed. The maximum number of characters permitted is 255. String String Path The path to and filename of an export of the tcpdump results. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object Force Enable this parameter to force the command to execute without a confirmation. SwitchParameter SwitchParameter InformationAction ActionPreference ActionPreference InformationVariable String String WhatIf Enable this parameter to see what the command will do without actually executing the command. SwitchParameter SwitchParameter Confirm Confirms that the action should be carried out. SwitchParameter SwitchParameter CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> TraceTcpTraffic Address 10.154.190.207 Path c:/example2/example2 Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. --------- The TCP trace results will be saved to the specified path. Uninstall-LmPatch Allows you to roll-back the LoadMaster to the previous version of firmware. Uninstall LmPatch Allows you to roll-back the LoadMaster to the previous version of firmware. You will be asked to restart the LoadMaster for the command to complete. Uninstall-LmPatch LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Uninstall-LmPatch LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Uninstall-LmPatch Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Data field...: @{PatchData=Previous firmware version successfully restored. Please reboot the LM to apply.} Uninstall-WafCustomRuleData Allows you to delete an AFP custom rule data file. Uninstall WafCustomRuleData Allows you to delete an AFP custom rule data file. Uninstall-WafCustomRuleData Filename The filename of the custom rule data file. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Uninstall-WafCustomRuleData Filename The filename of the custom rule data file. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String Filename The filename of the custom rule data file. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Uninstall-WafCustomRuleData -Filename modsecurity_35_bad_robots Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Uninstall-WafCustomRuleSet Allows you to delete custom AFP rule file Uninstall WafCustomRuleSet Allows you to delete custom AFP rule file Uninstall-WafCustomRuleSet Filename The filename of the custom rule. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Uninstall-WafCustomRuleSet Filename The filename of the custom rule. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String Filename The filename of the custom rule. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String This does not delete the associated data file. If the filename specified does not match a rule file that exists in the LoadMaster, a Rule not found error will be displayed. -------------------------- Example -------------------------- PS C:\> Uninstall-WafCustomRuleSet -Filename modsecurity_crs_11_brute_force Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Unregister-BondedInterface WARNING: This function is deprecated. Use the following command instead: Unregister-NetworkBondedInterface Unregister BondedInterface WARNING: This function is deprecated. Use the following command instead: Unregister-NetworkBondedInterface Unregister-BondedInterface InterfaceID Int16 LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String Unregister-BondedInterface InterfaceID Int16 LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String InterfaceID Int16 Int16 LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String Unregister-NetworkBondedInterface Enables you to unregister the address of a bonded interface. Unregister NetworkBondedInterface This command waits two minutes to reconnect to the LoadMaster. If the wait time is longer than two minutes, an error message appears. Unregister-NetworkBondedInterface InterfaceID The ID of the interface that should be unregistered. Int16 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Unregister-NetworkBondedInterface InterfaceID The ID of the interface that should be unregistered. Int16 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String InterfaceID The ID of the interface that should be unregistered. Int16 Int16 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Unregister-NetworkBondedInterface -InterfaceID 1 Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Data field...: @{Interface=} Id : 1 IPAddress : InterfaceType : Port GeoTrafficEnable : no DefaultInterface : no Update-AFEIDSRules Upload a new ruleset. Update AFEIDSRules To get updated or customized SNORT rules, please refer to the SNORT website: https://www.snort.org/. Update-AFEIDSRules Path The path to the rules file to be uploaded in the format <Path>\<Filename.Extension>, for example C:\t\community-rules.tar. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Update-AFEIDSRules Path The path to the rules file to be uploaded in the format <Path>\<Filename.Extension>, for example C:\t\community-rules.tar. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String Path The path to the rules file to be uploaded in the format <Path>\<Filename.Extension>, for example C:\t\community-rules.tar. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Update-AFEIDSRules -Path C:\t\community-rules.tar Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Update-GeoDatabase Install an updated GEO database patch file. Update GeoDatabase Install an updated GEO database patch file. Update-GeoDatabase Path The path to the patch file in the format path\filename.extension String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Update-GeoDatabase Path The path to the patch file in the format path\filename.extension String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String Path The path to the patch file in the format path\filename.extension String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Update-GeoDatabase –Path C:\Users\ExampleUser\Downloads\geodata.patch (1)\geodata.patch\geodata.patch_2017_03_01_0104 Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Update-GeoIPBlacklistDatabase Download the GEO IP blacklist database updates now. Update GeoIPBlacklistDatabase To manually download updates to the GEO IP blacklist database, run this command. Update-GeoIPBlacklistDatabase LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Update-GeoIPBlacklistDatabase LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Update-GeoIPBlacklistDatabase Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed. Download of new GEO IP Blacklist data successfully completed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Download of new GEO IP Blacklist data successfully completed. Update-LicenseOffline License the LoadMaster using the offline method. Update LicenseOffline Offline licensing requires a Binary Large OBject (BLOB) file which is provided by KEMP. The License BLOB is emailed to the customer when requested. Each time a license is updated a new BLOB is needed. The BLOB must be copied and pasted into a text file (in the following example the file is called license.txt). Update-LicenseOffline Path The path to the license BLOB file, including the filename and extension. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Update-LicenseOffline Path The path to the license BLOB file, including the filename and extension. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String Path The path to the license BLOB file, including the filename and extension. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Update-LicenseOffline -Path C:\ExamplePath\blob.txt Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Update-LicenseOnline Update the LoadMaster's license online. Update LicenseOnline Cause the LoadMaster to query the KEMP licensing system for an updated license. Update-LicenseOnline KempId The email address you used when registering for a KEMP ID. String Password The password of your KEMP ID account. String OrderId The Orderid parameter is only needed for Virtual LoadMasters. The Order ID is provided by KEMP after a license is purchased. String http_proxy You can optionally use a HTTP(S) proxy to connect to the licensing server. Specify the HTTP(S) proxy server and port, in the format <ProxyAddress>:<Port>. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Update-LicenseOnline KempId The email address you used when registering for a KEMP ID. String Password The password of your KEMP ID account. String OrderId The Orderid parameter is only needed for Virtual LoadMasters. The Order ID is provided by KEMP after a license is purchased. String http_proxy You can optionally use a HTTP(S) proxy to connect to the licensing server. Specify the HTTP(S) proxy server and port, in the format <ProxyAddress>:<Port>. String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String KempId The email address you used when registering for a KEMP ID. String String Password The password of your KEMP ID account. String String OrderId The Orderid parameter is only needed for Virtual LoadMasters. The Order ID is provided by KEMP after a license is purchased. String String http_proxy You can optionally use a HTTP(S) proxy to connect to the licensing server. Specify the HTTP(S) proxy server and port, in the format <ProxyAddress>:<Port>. String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Update-LicenseOnline -KempId exampleuser@examplecompany.com -Password examplepassword Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Update-LmDNSCache WARNING: This function is deprecated. Use the following command instead: Update-NetworkDNSCache Update LmDNSCache WARNING: This function is deprecated. Use the following command instead: Update-NetworkDNSCache Update-LmDNSCache LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Update-LmDNSCache LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Update-LmDnsCache Example Output: ReturnCode Data Response ---------- ---- -------- 200 Command successfully executed Update-NetworkDNSCache Force a new resolution of DNS names. Update NetworkDNSCache The LoadMaster will try to resolve the DNS names: • If the address is not found, or if it is the same as before – nothing is done (except a log entry is generated). • If the address is different, the Real Server entry will be updated with the new address, if possible. • If the new address is invalid for some reason, for example if it is a non-local address and the Non-Local Real Servers setting has been disabled, no changes are made and a log is generated. Update-NetworkDNSCache LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Update-NetworkDNSCache LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Update-NetworkDNSCache Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Update-WafRulesDatabase Manually trigger the installation of downloaded rules. Update WafRulesDatabase Manually trigger the installation of downloaded Web Application Firewall (WAF) rules. Update-WafRulesDatabase LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String Update-WafRulesDatabase LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String InformationAction ActionPreference InformationVariable String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. String String -------------------------- Example -------------------------- PS C:\> Update-WafRulesDatabase Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. UploadAddon WARNING: This function is deprecated. Use the following command instead: Install-LmAddon WARNING: This function is deprecated. Use the following command instead: Install-LmAddon UploadAddon Path String LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String UploadAddon Path String LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String Path String String LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String UploadRSAConfigurationFile WARNING: This function is deprecated. Use the following command instead: Get-SSODomainSession WARNING: This function is deprecated. Use the following command instead: Get-SSODomainSession UploadRSAConfigurationFile Path String LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String UploadRSAConfigurationFile Path String LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String Path String String LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String UploadRSANodeSecretAndPassword WARNING: This function is deprecated. Use the following command instead: Stop-SSODomainSession WARNING: This function is deprecated. Use the following command instead: Stop-SSODomainSession UploadRSANodeSecretAndPassword Password String Path String LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String UploadRSANodeSecretAndPassword Password String Path String LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String Password String String Path String String LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String UploadTemplate WARNING: This function is deprecated. Use the following command instead: Install-Template WARNING: This function is deprecated. Use the following command instead: Install-Template UploadTemplate Path String LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String UploadTemplate Path String LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String Path String String LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String UserChangeLocalPassword WARNING: This function is deprecated. Use the following command instead: Set-SecUserPassword WARNING: This function is deprecated. Use the following command instead: Set-SecUserPassword UserChangeLocalPassword User String Password String Radius Int32 LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String UserChangeLocalPassword User String Password String Radius Int32 LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String User String String Password String String Radius Int32 Int32 LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String UserSetPermissions WARNING: This function is deprecated. Use the following command instead: Set-SecUserPermission WARNING: This function is deprecated. Use the following command instead: Set-SecUserPermission UserSetPermissions User String Permissions String LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String UserSetPermissions User String Permissions String LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String User String String Permissions String String LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String UserSetSystemPassword WARNING: This function is deprecated. Use the following command instead: Set-SecSystemUserPassword WARNING: This function is deprecated. Use the following command instead: Set-SecSystemUserPassword UserSetSystemPassword CurrentPassword String NewPassword String LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String CurrentPassword String String NewPassword String String LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String VSAddWafRule WARNING: This function is deprecated. Use the following command instead: New-AdcVsWafRule WARNING: This function is deprecated. Use the following command instead: New-AdcVsWafRule VSAddWafRule VS The IP address of the relevant Virtual Service. String VSPort String VSProtocol String Rule Specify the name of the rule to be assigned. The rule name must be preceded with a letter/word and a forward slash. The letter used depends on the type of rule being added: - C or Custom - Z or ApplicationGeneric - A or ApplicationSpecific - G or Generic String Enablerules String Disablerules String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object InformationAction ActionPreference InformationVariable String VSAddWafRule VS The IP address of the relevant Virtual Service. String VSPort String VSProtocol String Rule Specify the name of the rule to be assigned. The rule name must be preceded with a letter/word and a forward slash. The letter used depends on the type of rule being added: - C or Custom - Z or ApplicationGeneric - A or ApplicationSpecific - G or Generic String Enablerules String Disablerules String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String VS The IP address of the relevant Virtual Service. String String VSPort String String VSProtocol String String Rule Specify the name of the rule to be assigned. The rule name must be preceded with a letter/word and a forward slash. The letter used depends on the type of rule being added: - C or Custom - Z or ApplicationGeneric - A or ApplicationSpecific - G or Generic String String Enablerules String String Disablerules String String LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. String String LBPort Int32 Int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String Port Specifies the port on which this Virtual Service accepts connections. string string Prot Specifies the communication protocol of the Virtual Service. Valid options are TCP or UDP. string string The rule name must be preceded with the relevant letter/word and a forward slash. The letter/word used depends on the type of rule being assigned. This is case sensitive. The letter/word needs to be in the correct case for the command to work. • C or Custom • Z or ApplicationGeneric • A or ApplicationSpecific • G or Generic Multiple rules can be assigned in the same command by separating them with a space. An invalid rule error will display if the name of the rule is not entered correctly, if the preceding letter is incorrect, or if the does not exist in the LoadMaster. -------------------------- Example -------------------------- PS C:\> VSAddWafRule -VS 10.11.0.31 -Port 80 -Prot tcp -Rule C/modsecurity_crs_11_brute_force Example Output: ok VSListWafRuleIds WARNING: This function is deprecated. Use the following command instead: Get-AdcVsWafRule WARNING: This function is deprecated. Use the following command instead: Get-AdcVsWafRule VSListWafRuleIds VS String VSPort String VSProtocol String Rule String LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String VSListWafRuleIds VS String VSPort String VSProtocol String Rule String LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String VS String String VSPort String String VSProtocol String String Rule String String LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String VSRemoveWafRule WARNING: This function is deprecated. Use the following command instead: Remove-AdcVsWafRule WARNING: This function is deprecated. Use the following command instead: Remove-AdcVsWafRule VSRemoveWafRule VS String VSPort String VSProtocol String Rule String LoadBalancer String LBPort Int32 Credential Object InformationAction ActionPreference InformationVariable String VSRemoveWafRule VS String VSPort String VSProtocol String Rule String LoadBalancer String LBPort Int32 CertificateStoreLocation String SubjectCN String InformationAction ActionPreference InformationVariable String VS String String VSPort String String VSProtocol String String Rule String String LoadBalancer String String LBPort Int32 Int32 Credential Object Object InformationAction ActionPreference ActionPreference InformationVariable String String CertificateStoreLocation String String SubjectCN String String Set-TlsHSMCACert Allows you to upload the CA certificate that has been downloaded from the HSM. Allows you to upload the CA certificate that has been downloaded from the HSM. Path The path to the certificate file followed by a backslash and the certificate file name followed by the file extension (.pem). string string LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. string string LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. int32 int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. object object InformationAction actionpreference actionpreference InformationVariable string string CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string -------------------------- Example -------------------------- PS C:\> Set-TlsHSMCACert –Path <Path\CertificateFileName.pem> Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Get-ClusterAwsHaConfiguration Retrieve the AWS High Availability (HA) parameters. Retrieve the AWS High Availability (HA) parameters. LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. string string LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. int32 int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. object object InformationAction actionpreference actionpreference InformationVariable string string CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string -------------------------- Example -------------------------- PS C:\> Get-KEMPClusterAwsHaConfiguration Example Output: AwsHA ----- single,unset,unset Get-ClusterAzureHAConfiguration Retrieves the Azure High Availability (HA) parameters. Retrieves the Azure High Availability (HA) parameters. LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. string string LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. int32 int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. object object InformationAction actionpreference actionpreference InformationVariable string string CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string -------------------------- Example -------------------------- PS C:\> Get-ClusterAzureHAConfiguration Example Output: ok Get-ClusterHAConfiguration Allows you to view the values of High Availability (HA) options. Allows you to view the values of High Availability (HA) options. LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. string string LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. int32 int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. object object InformationAction actionpreference actionpreference InformationVariable string string CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string This is a legacy command and does not return all of the available parameters. Please refer to the Get-Help of the Get-Parameter command to view a full list of parameters that can be returned. -------------------------- Example -------------------------- PS C:\> Get-ClusterHAConfiguration Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed; Data=} Return Code..: 200 Response.....: Command successfully executed hamode : HA Second hatimeout : 3 hawait : 0 havhid : 0 haprefered : No Preferred Host haif : 0 hal4update : no hal7update : no Get-ClusterHAMode Retrieve the High Availability (HA) mode. The HA mode is one of the following options: 0 – HA mode disabled 1 – HA 1 mode 2 – HA 2 mode 3 – System is using cloud HA 4 – System is in a cluster LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. string string LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. int32 int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. object object InformationAction actionpreference actionpreference InformationVariable string string CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string -------------------------- Example -------------------------- PS C:\> Get-ClusterHAMode Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed; Data=} Return Code..: 200 Response.....: Command successfully executed HaMode : 2 HaDescription : HA Second Set-ClusterAwsHAConfiguration Set the Amazon Web Services (AWS) High Availability (HA) options. Set the AWS HA options, such as the health check port and partner address. Partner Address of the HA partner. string string Hcp The port over which the health check is run. This needs to be the same on both the master and the slave units in order for HA to function correctly. string string haprefered int32 int32 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. string string LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. int32 int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. object object InformationAction actionpreference actionpreference InformationVariable string string CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string -------------------------- Example -------------------------- PS C:\> Set-ClusterAwsHAConfiguration –Hcp 443 –Partner <PartnerIPAddress> Example Output: ok Set-ClusterAwsHAMode Allows you to specify the Amazon Web Services (AWS) HA mode. Allows you to specify the Amazon Web Services (AWS) HA mode, for example, master HA Mode, slave HA Mode or Non-HA mode. HAMode Specifies the HA mode. Valid values are: - master - slave - single string string LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. string string LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. int32 int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. object object InformationAction actionpreference actionpreference InformationVariable string string CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string -------------------------- Example -------------------------- PS C:\> Set-ClusterAwsHAMode –HAMode master Example Output: ok Set-ClusterAzureHAConfiguration Allows you to set the other Azure HA options: health check port and partner address. Allows you to set the other Azure HA options: health check port and partner address. Partner Address of the HA partner. string string Hcp The port over which the health check is run. This needs to be the same on both the master and the slave units in order for HA to function correctly. string string haprefered int32 int32 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. string string LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. int32 int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. object object InformationAction actionpreference actionpreference InformationVariable string string CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string -------------------------- Example -------------------------- PS C:\> Set-ClusterAzureHAConfiguration –Hcp 443 –Partner <PartnerIPAddress> Example Output: ok Set-ClusterAzureHAMode Allows you to specify the Azure HA mode. Allows you to specify the Azure HA mode. For example, Master HA Mode, Slave HA Mode or Non-HA Mode (single). HAMode Specifies the HA mode. Valid options are master, slave or single. string string LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. string string LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. int32 int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. object object InformationAction actionpreference actionpreference InformationVariable string string CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string -------------------------- Example -------------------------- PS C:\> Set-ClusterAzureHAMode –HAMode master Example Output: ok Set-ClusterHAConfiguration Allows you to set the values of High Availability (HA) options. Allows you to set the values of High Availability (HA) options. hatimeout The time the master must be unavailable before a switchover occurs. The valid predetermined time intervals are listed below (in seconds): 3 6 9 12 15 int16 int16 hawait This is how long (in seconds) after the initial boot, before the LoadMaster becomes active. If the partner machine is running this value is ignored. This value can be changed to mitigate the time taken for some intelligent switches to detect that the LoadMaster has started and to bring up the link. int16 int16 havhid When using multiple HA LoadMasters on the same network, this value identifies each cluster so that there are no potential unwanted interactions. int16 int16 haprefered By default, neither partner in a HA cluster has priority. When a machine restarts after a switchover that machine becomes a slave. Specifying a preferred host means that when this machine restarts it will always become the master and the partner will revert to slave mode. string string haif The network interface used when synchronising the configuration between the members of the HA cluster. int16 int16 hal4update boolean boolean hal7update boolean boolean LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. string string LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. int32 int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. object object InformationAction actionpreference actionpreference InformationVariable string string CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string HAInitial Perform extra network checks at boot time. This may cause instability and should not be used. boolean boolean HAStyle By default, the system uses a version of VRRP (carp) to check the status of the partner. The system can also support the legacy Heartbeat program. This option only takes effect when both machines are rebooted. boolean boolean MCast The network interface used for multicast traffic which is used to synchronize Layer 4 and Layer 7 traffic when Inter HA Updates are enabled. int16 int16 Vmac This option creates a shared MAC address for both units. When failover occurs, the LoadMaster handles the MAC address handover too. This allows the switches to keep the MAC address and not worry about ARP caches or stale records. boolean boolean TCPFailover When using L4 services, enabling updates allows L4 connection maintenance across a HA switchover. This option is ignored for L7 services. boolean boolean CookieUpdate When using L7 services, enabling this option allows sharing of persistency information between HA partners. If a HA switchover occurs, the persistency information will then not be lost. Enabling this option can have a significant performance impact. boolean boolean FinalPersist When a Real Server is disabled, the sessions persisting on that Real Server continue to be served until the Drain Time has expired or until no more sessions are being handled by the Real Server. No new sessions will be handled by the Real Server. int32 int32 This is a legacy command and cannot be used to set all of the available parameters. Please refer to the Get-Help of the Set-Parameter command to view a full list of parameters that can be configured. -------------------------- Example -------------------------- PS C:\> Set-ClusterHAConfiguration -HATimeout 3 Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. hatimeout : 3 Set-ClusterHAMode Set the High Availability (HA) mode. Set the HA mode. HaMode The HA mode can be one of the following options: SingleMode - Non-HA mode First - HA 1 mode Second - HA 2 mode string string LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. string string LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. int32 int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. object object InformationAction actionpreference actionpreference InformationVariable string string CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string -------------------------- Example -------------------------- PS C:\> Set-ClusterHAMode -HaMode SingleMode Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Get-PacketFilterOption Retrieves the value of the Packet Routing Filter option. Retrieves the value of the Packet Routing Filter option. This can also be used to determine whether packet filtering is enabled. LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. string string LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. int32 int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. object object InformationAction actionpreference actionpreference InformationVariable string string CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string Option The following packet filtering options are supported: enable, drop or ifblock The "enable" option indicates whether packet filtering is enabled or disabled on the LoadMaster. Note that packet filtering is enabled by default and cannot be disabled if the GEO feature is enabled. If packet filtering is enabled, the "drop" option indicates whether the LoadMaster silently drops blocked packets or rejects them by responding with an ICMP reject packet. For security reasons it is usually best to drop any blocked packets silently. If packet filtering is enabled, the "ifblock" option indicates whether the LoadMaster restricts network traffic by imposing restrictions upon routing between attached subnets. string string -------------------------- Example -------------------------- PS C:\> Get-PacketFilterOption -Option enable Example Output: aclstatus --------- enable New-GlobalPacketFilterAddr Adds an address to the global black or white list. Adds a host or network IP address to the global black or white Access Control List (ACL). Note that black and white lists are only enabled when packet filtering is enabled. Type Specifies the access control list type: black or white. string string Address Specifies a host or network IP address to add to the access control list. The address can be specified in CIDR format. If the CIDR is not specified, the system uses a default of /32. string string Comment Optionally add a comment about the entry. This parameter accepts a maximum of 127 characters. string string LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. string string LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. int32 int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. object object InformationAction actionpreference actionpreference InformationVariable string string CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string -------------------------- Example -------------------------- PS C:\> New-GlobalPacketFilterAddr -Type black -Address 10.35.47.16 Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Remove-GlobalPacketFilterAddr Removes an address from the global black or white list. Removes a host or network IP address from the global black or white access control list. Note that black and white lists are only enabled when packet filtering is enabled. Type Specifies the access control list type: "black" or "white". string string Address Specifies a host or network IP address to remove from the access control list. The address can be specified in CIDR format. If the CIDR is not specified, the system uses a default of /32. string string LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. string string LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. int32 int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. object object InformationAction actionpreference actionpreference InformationVariable string string CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string -------------------------- Example -------------------------- PS C:\> Remove-GlobalPacketFilterAddr -Address 10.154.11.197 -Type black Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Set-PacketFilterOption Sets a packet filtering option. Sets a packet filtering option. This can also be used to enable or disable packet filtering. Note that packet filtering cannot be disabled if the GEO feature is enabled. Option The following packet filtering options are supported: enable, drop or ifblock The "enable" option indicates whether packet filtering is enabled or disabled on the LoadMaster. Note that packet filtering is enabled by default and cannot be disabled if the GEO feature is enabled. If packet filtering is enabled, the "drop" option indicates whether the LoadMaster silently drops blocked packets or rejects them by responding with an ICMP reject packet. For security reasons it is usually best to drop any blocked packets silently. If packet filtering is enabled, the "ifblock" option indicates whether the LoadMaster restricts network traffic by imposing restrictions upon routing between attached subnets. string string Value Specify whether to enable or disable the specified Option: 0 – Disabled 1 – Enabled boolean boolean LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. string string LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. int32 int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. object object InformationAction actionpreference actionpreference InformationVariable string string CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string -------------------------- Example -------------------------- PS C:\> Set-PacketFilterOption -Option drop -Value 0 Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Add-AdcHttpCacheException Allows you to add an extension to the 'Do Not Cache' extension list. Allows you to add an extension to the 'Do Not Cache' extension list. Extension The file extension that should not be cached. (e.g. ".jpg") The extension must start with a "." A collection of extensions can be provided through the pipeline. string[] string[] LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. string string LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. int32 int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. object object InformationAction actionpreference actionpreference InformationVariable string string CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string -------------------------- Example -------------------------- PS C:\> Add-AdcHttpCacheException -Extension .mp4 Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Add-AdcHttpCompressionException Allows you to add an extension to the 'Do Not Compress' extension list. Allows you to add an extension to the 'Do Not Compress' extension list. Extension The file extension that should not be compressed. (e.g. ".jpg") The extension must start with a ".". A collection of extensions can be provided through the pipeline. This parameter is required. string[] string[] LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. string string LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. int32 int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. object object InformationAction actionpreference actionpreference InformationVariable string string CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string -------------------------- Example -------------------------- PS C:\> Add-AdcHttpCompressionException -Extension .mp4 Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Add-AdcVsWafRule Assign a Web Application Firewall (WAF) rule to a Virtual Service. This command assigns the specified rule to the Virtual Service. VS The IP address of the Virtual Service to add the rule to. string string VSPort The port number of the Virtual Service to add the rule to. string string VSProtocol The protocol of the Virtual Service to add the rule to. string string Rule The <RuleName> must be preceded with the relevant letter or word and a forward slash. The letter/word used depends on the type of rule being added: C or Custom Z or ApplicationGeneric A or ApplicationSpecific G or Generic This is case sensitive. The letter/word needs to be in in the correct case for the command to work. Multiple rules can be assigned in the same command by separating them with a space (or %20). string string Enablerules Specific rules can be enabled per ruleset by including the enablerules parameter and specifying the rule IDs to be enabled. string string Disablerules Multiple rules can be disabled/enabled in the one command by specifying a comma-separated list of IDs for the disablerules/enablerules parameter. string string LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. string string LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. int32 int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. object object InformationAction actionpreference actionpreference InformationVariable string string CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string -------------------------- Example -------------------------- PS C:\> Add-AdcVsWafRule -Rule G/ip_reputation -VS 10.35.47.16 -VSPort 80 -VSProtocol tcp Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Add-ClusterNode Adds a single node LoadMaster (which is available to be added) to the cluster. Adds a single node LoadMaster (which is available to be added) to the cluster. Address The IP address of the node LoadMaster. string string LoadBalancer The IP address of the KEMP LoadMaster that you are directing the command to. This can be set globally by using the Initialize-LmConnectionParameters command, but can be overridden on each individual command by using this parameter. string string LBPort The port of the load balancer. int32 int32 Credential Specifies a user account that has permission to administer the load balancer. You can either enter a username for the load balancer or provide a PSCredential object, such as an object that is returned by the Get-Credential cmdlet. When you type a username, you are prompted for a password. object object InformationAction actionpreference actionpreference InformationVariable string string CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string Before running this command, the node LoadMaster needs to be be available to be added. To make the node LoadMaster available, run the NMJoinCluster command. If the Add-ClusterNode command is run when the node LoadMaster is not available, an error will be returned which says that the machine could not be contacted. -------------------------- Example -------------------------- PS C:\> Add-ClusterNode -Address 10.154.11.20 Example Output: ok Add-LmIPConnectionLimit Allows you to add an IP address to be limited. Allows you to add an IP address to be limited. L7addr Add the IP address or network to be limited. string string L7limit Limit the number of connection attempts (per second) from a specific host/network. int32 int32 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. string string LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. int32 int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. object object InformationAction actionpreference actionpreference InformationVariable string string CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string -------------------------- Example -------------------------- PS C:\> Add-LmIPConnectionLimit -L7addr 10.10.10.10 -L7limit 25 Example Output: Ok Add-NetworkBondedInterface Add a standalone interface to a bonded interface. Add a standalone interface to a bonded interface. InterfaceID The Interface ID that should be bound to the Bonded Interface. To view the interface ID for each of the interfaces, run the Get-LogStatistics command. The interface ID is the first number displayed in each interface row. int16 int16 BondID The Bonded Interface ID that the network interface should be bound to. int16 int16 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. string string LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. int32 int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. object object InformationAction actionpreference actionpreference InformationVariable string string CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string -------------------------- Example -------------------------- PS C:\> Add-NetworkBondedInterface -BondID 0 -InterfaceID 0 Example Output: Mtu : 1500 InterfaceType : Bonded Id : 1 DefaultInterface : no BondMembers : 1,2 GeoTrafficEnable : no NBondMembers : 2 Mode : 802.3ad IPAddress : 172.22.56.102/24 Add-NetworkInterfaceAdditionalAddress Add an additional address to an interface. Specify an additional address to be used on the interface. InterfaceID The ID number of the interface to add the additional address to. int16 int16 Address The additional address to be added. string string LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. string string LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. int32 int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. object object InformationAction actionpreference actionpreference InformationVariable string string CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string -------------------------- Example -------------------------- PS C:\> Add-NetworkInterfaceAdditionalAddress -Address 10.154.11.22 Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Id : 0 IPAddress : 10.154.11.180/16 Mtu : 1400 AdditionalAddresses : @{IPaddress=10.154.11.22/16} InterfaceType : Port GeoTrafficEnable : yes DefaultInterface : yes Add-NetworkVLAN Allows you to add a Virtual LAN. Allows you to add a Virtual LAN. InterfaceID The ID of the interface to be added to the VLAN. int16 int16 VLanId int16 int16 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. string string LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. int32 int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. object object InformationAction actionpreference actionpreference InformationVariable string string CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string VLAN The VLAN that the specified interface should be added to. int16 int16 -------------------------- Example -------------------------- PS C:\> Add-NetworkVLAN -InterfaceID 1 -VLAN 1 Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Data field...: @{Interface=} Id : 2 IPAddress : VlanId : 1 RealInterface : 1 InterfaceType : Vlan GeoTrafficEnable : no DefaultInterface : no Add-NetworkVxLAN Creates a new VXLAN interface. Creates a new VXLAN interface. InterfaceID The ID of the interface to add the VXLAN to. int16 int16 VNI int32 int32 Addr The multicast group or remote address. string string LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. string string LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. int32 int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. object object InformationAction actionpreference actionpreference InformationVariable string string CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string VXLAN The VXLAN Network Identifier. int32 int32 -------------------------- Example -------------------------- PS C:\> Add-NetworkVxLAN -Addr 10.154.11.34 -InterfaceID 1 -VNI 1 Example Output: Full response: @{ReturnCode=200; Response=Command successfully executed.; Data=} Return Code..: 200 Response.....: Command successfully executed. Data field...: @{Interface=} Id : 2 IPAddress : VNI : 1 RemoteAddress : 10.154.11.34 RealInterface : 1 InterfaceType : VXlan GeoTrafficEnable : no DefaultInterface : no Add-SdnController Used to add an SDN controller to the LoadMaster. Used to add an SDN controller to the LoadMaster. IPV4 The IPv4 address of the SDN controller. string string Port The port of the SDN controller. int32 int32 Clid The cluster ID for the new SDN controller. If a number is specified, the SDN controller will be added to the cluster with the relevant ID number. The cluster with the ID number specified must already exist. If a number is not specified, the SDN controller will be added to a new cluster. int32 int32 Https The HTTP method to use. 0 - HTTP 1 - HTTPS boolean boolean User The username to be used to access the SDN controller RESTful API. string string Password The password to be used to access the SDN controller RESTful API. string string LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. string string LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. int32 int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. object object InformationAction actionpreference actionpreference InformationVariable string string CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string -------------------------- Example -------------------------- PS C:\> Add-SdnController -IPV4 10.154.11.28 -Port 8443 -Https 1 -Password examplepassword -User exampleuser Example Output: port : 8443 ipv4 : 10.154.11.28 user : exampleuser password : *************** https : yes Add-WafCustomRuleData Allows you to upload a custom rule data file to the LoadMaster. Allows you to upload a custom rule data file to the LoadMaster. Filename The filename of the custom rule data file followed by the file extension (.data). string string Path The path where the custom rule data file is stored followed by a back slash and the filename/extension. string string LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. string string LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. int32 int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. object object InformationAction actionpreference actionpreference InformationVariable string string CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string -------------------------- Example -------------------------- PS C:\> Add-WafCustomRuleData -Filename modsecurity_40_generic_attacks.data -Path "C:\modsecurity-crs_2.2.5\modsecurity-crs_2.2.5\base_rules\modsecurity_40_generic_attacks.data" Example Output: Ok Add-WafCustomRuleSet Allows you to upload custom AFP rulefiles or a rule set to the LoadMaster. Allows you to upload custom AFP rulefiles or a rule set to the LoadMaster. Filename The desired rule name to be displayed on the WUI. This is only relevant for individual rule files. string string Path The path to the custom rule file(s) or rule set file followed by a forward slash and then the filename.extension. string string LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. string string LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. int32 int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. object object InformationAction actionpreference actionpreference InformationVariable string string CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string -------------------------- Example -------------------------- PS C:\> Add-WafCustomRuleSet -Filename SpiderLabs-owasp-modsecurity-crs-2.2.9-5-gebe8790.tar.gz -Path "C:\SpiderLabs-owasp-modsecurity-crs-2.2.9-5-gebe8790.tar.gz" Example Output: Ok Get-VpnIkeDaemonStatus Allows you to view the status of the IKE daemon. Allows you to view the status of the IKE daemon. LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. string string LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. int32 int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. object object InformationAction actionpreference actionpreference InformationVariable string string CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string -------------------------- Example -------------------------- PS C:\> Get-VpnIkeDaemonStatus Example Output: status ------ Up Set-VpnAddrs Allows you to set the VPN addresses at the same time. Allows you to set the VPN addresses at the same time. Name The name of the VPN. string string LocalIp In non-HA mode, the default is the LoadMaster IP address, i.e. the IP address of the default gateway interface. In HA-mode, the default is the shared IP address. string string LocalSubnets When the LocalIp is set, the LocalSubnet is automatically populated. Multiple local subnets can be specified using a comma-separated list. Up to 10 IP addresses can be specified. string string RemoteIp Set the IP address for the remote side of the connection. string string RemoteSubnets Set the subnet for the remote side of the connection. Multiple remote subnets can be specified using a comma-separated list. Up to 10 IP addresses can be specified. string string LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. string string LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. int32 int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. object object InformationAction actionpreference actionpreference InformationVariable string string CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string -------------------------- Example -------------------------- PS C:\> Set-VpnAddrs -LocalIp 10.11.0.11 -LocalSubnets 10.11.0.12 -Name ExampleVPN -RemoteIp 10.11.0.13 -RemoteSubnets 10.11.0.14 Example Output: status : Down localIP : 10.11.0.11 localSubnets : 10.11.0.12/32 remoteIP : 10.11.0.13 remoteSubnets : 10.11.0.14/32 Set-VpnLocalIp Allows you to set the local IP address of a VPN. Allows you to set the local IP address of a VPN. Name The name of the VPN. string string LocalIp In non-HA mode, the default is the LoadMaster IP address, i.e. the IP address of the default gateway interface. In HA-mode, the default is the shared IP address. string string LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. string string LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. int32 int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. object object InformationAction actionpreference actionpreference InformationVariable string string CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string -------------------------- Example -------------------------- PS C:\> Set-VpnLocalIp -LocalIp 10.11.0.11 -Name ExampleVPN Example Output: ok Set-VpnLocalSubnet Allows you to set the Local Subnet Address(es). Allows you to set the Local Subnet Address(es). Name The name of the VPN. string string LocalSubnets When the LocalIp is set, the LocalSubnet is automatically populated. Multiple local subnets can be specified using a comma-separated list. Up to 10 IP addresses can be specified. string string LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. string string LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. int32 int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. object object InformationAction actionpreference actionpreference InformationVariable string string CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string -------------------------- Example -------------------------- PS C:\> Set-VpnLocalSubnet -LocalSubnets 10.11.0.11 -Name ExampleVPN Example Output: ok Set-VpnPfsDisable Allows you to disable the Perfect Forward Secrecy option for a particular VPN connection. Allows you to disable the Perfect Forward Secrecy option for a particular VPN connection. Name The name of the VPN connection. string string LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. string string LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. int32 int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. object object InformationAction actionpreference actionpreference InformationVariable string string CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string -------------------------- Example -------------------------- PS C:\> Set-VpnPfsDisable -Name ExampleConnection Example Output: ok Set-VpnPfsEnable Allows you to enable the Perfect Forward Secrecy option for a particular VPN connection. Allows you to enable the Perfect Forward Secrecy option for a particular VPN connection. Name The name of the VPN connection. string string LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. string string LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. int32 int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. object object InformationAction actionpreference actionpreference InformationVariable string string CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters.ertificate is searched for in the default Cert:\CurrentUser\My location. string string -------------------------- Example -------------------------- PS C:\> Set-VpnPfsEnable -Name ExampleConnection Example Output: ok Set-VpnRemoteIp Allows you to set the Remote IP Address of the specified VPN. Allows you to set the Remote IP Address of the specified VPN. Name The name of the VPN. string string RemoteIp Set the IP address for the remote side of the connection. string string LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. string string LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. int32 int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. object object InformationAction actionpreference actionpreference InformationVariable string string CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string -------------------------- Example -------------------------- PS C:\> Set-VpnRemoteIp -Name ExampleVPN -RemoteIp 10.11.0.12 Example Output: ok Set-VpnRemoteSubnet Allows you to set the Remote Subnet Address(es) of the specified VPN. Allows you to set the Remote Subnet Address(es) of the specified VPN. Name The name of the VPN. string string RemoteSubnets Set the subnet for the remote side of the connection. Multiple remote subnets can be specified using a comma-separated list. Up to 10 IP addresses can be specified. string string LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. string string LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. int32 int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. object object InformationAction actionpreference actionpreference InformationVariable string string CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string -------------------------- Example -------------------------- PS C:\> Set-VpnRemoteSubnet -Name ExampleVPN -RemoteSubnets 10.11.0.13 Example Output: ok Set-VpnSecret Allows you to set the connection secret details of the specified VPN. Allows you to set the connection secret details of the specified VPN. Name The name of the VPN. string string LocalId Identification for the local side of the connection. string string RemoteId Identification for the remote side of the connection. This can be the remoteip. string string Key The Pre Shared Key (PSK) string. This is the Shared key which is generated and managed on the Azure side. The key length should be at least 16 and at most 64 characters. string string LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. string string LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. int32 int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. object object InformationAction actionpreference actionpreference InformationVariable string string CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string -------------------------- Example -------------------------- PS C:\> Set-VpnSecret -Key examplepresharedkey -LocalId 10.11.0.11 -Name ExampleVPN -RemoteId 10.11.0.12 Example Output: status localID remoteID key ------ ------- -------- --- Down 10.11.0.11 10.11.0.12 examplepresharedkey Start-VpnConnection Allows you to start the connection of specified VPN. Allows you to start the connection of specified VPN. Name The name of the VPN. string string LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. string string LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. int32 int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. object object InformationAction actionpreference actionpreference InformationVariable string string CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string -------------------------- Example -------------------------- PS C:\> Start-VpnConnection -Name ExampleVPN Example Output: ok Start-VpnIkeDaemon Starts the IKE daemon. Starts the IKE daemon. LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. string string LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. int32 int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. object object InformationAction actionpreference actionpreference InformationVariable string string CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string -------------------------- Example -------------------------- PS C:\> Start-VpnIkeDaemon Example Output: ok Stop-VpnConnection Allows you to stop the connection of specified VPN. Allows you to stop the connection of specified VPN. Name The name of the VPN. string string LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. string string LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. int32 int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. object object InformationAction actionpreference actionpreference InformationVariable string string CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string -------------------------- Example -------------------------- PS C:\> Stop-VpnConnection -Name ExampleVPN Example Output: ok Stop-VpnIkeDaemon Allows you to stop the Internet Key Exchange (IKE) daemon. Allows you to stop the Internet Key Exchange (IKE) daemon. LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. string string LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. int32 int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. object object InformationAction actionpreference actionpreference InformationVariable string string CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string -------------------------- Example -------------------------- PS C:\> Stop-VpnIkeDaemon Example Output: ok Add-GlobalPacketFilterAddr Adds an address to the global black or white list. Adds a host or network IP address to the global black or white Access Control List (ACL). Note that black and white lists are only enabled when packet filtering is enabled. Type Specifies the access control list type: "black" or "white". string string Address Specifies a host or network IP address to add to the access control list. The address can be specified in CIDR format. If the CIDR is not specified, the system uses a default of /32. string string Comment Optionally add a comment about the entry. This parameter accepts a maximum of 127 characters. string string LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. string string LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. int32 int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. object object InformationAction actionpreference actionpreference InformationVariable string string CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string -------------------------- Example -------------------------- PS C:\> Add-GlobalPacketFilterAddr -Address 10.154.11.197 -Type black Example Output: Ok Add-GeoCountry Assigns a country or continent to an IP address in an FQDN which has the Selection Criteria set to Location Based. Assigns a country or continent to an IP address in an FQDN which has the Selection Criteria set to Location Based. FQDN The name of the FQDN. string string IP IP address of the map to be modified. string string CountryCode Two-letter country or continent code for the country/continent to be assigned. The country code and continent codes used are the standard ISO codes. To specify everywhere as the country, type ALL as the country code and set the IsContinent parameter to yes. string string IsContinent Some country codes and continent codes are the same, for example AF could mean Africa or Afghanistan. You must specify in this parameter if the code is for a country or continent. yes – code is for a continent no – code is for a country string string CustomLocation The name of an existing custom location. string string LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. string string LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. int32 int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. object object InformationAction actionpreference actionpreference InformationVariable string string CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string -------------------------- Example -------------------------- PS C:\> Add-GeoCountry –CountryCode <TwoCharacterCountryCode> -FQDN <FQDNName> -IP <IPAddress> -IsContinent <yes/no> Example Output: Ok Add-GeoCustomLocation Creates a custom GEO location which can be selected when using the Location Based selection criteria. Creates a custom GEO location which can be selected when using the Location Based selection criteria. Location The name of the custom location. string string LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. string string LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. int32 int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. object object InformationAction actionpreference actionpreference InformationVariable string string CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string -------------------------- Example -------------------------- PS C:\> Add-GeoCustomLocation –Location <LocationName> Example Output: Ok Add-GeoFQDNSiteAddress Allows you to add an IP address to an FQDN. Allows you to add an IP address to an FQDN. FQDN The name of the FQDN. string string IP IPv4 or IPv6 address to be added to the FQDN. string string Cluster If needed, enter the cluster name where the IP address is located. string string LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. string string LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. int32 int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. object object InformationAction actionpreference actionpreference InformationVariable string string CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string -------------------------- Example -------------------------- PS C:\> Add-GeoFQDNSiteAddress –FQDN <FQDNName> -IP <IPAddress> -Cluster <ClusterName> Example Output: Ok Add-GeoIPWhitelist Add an IP address or network to the whitelist. Run this command to add an IP address or network to the user-defined whitelist. The whitelist entries override the blacklist. Addr The address or network to be added to the GEO Access Control whitelist. string string LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. string string LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. int32 int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. object object InformationAction actionpreference actionpreference InformationVariable string string CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string -------------------------- Example -------------------------- PS C:\> Add-GeoIPWhitelist -Addr 10.154.11.34 Example Output: ReturnCode Data Response ---------- ---- -------- 200 Command successfully executed Add-VSPacketFilterAddr Adds an address to the black or white list for a Virtual Service. Adds a host or network IP address to the black or white access control list for a specific Virtual Service. Note that black and white lists are only enabled when packet filtering is enabled. VirtualService Specifies the Virtual Service IP address. string string Port Specifies the Virtual Service port number. int32 int32 Protocol Specifies the Virtual Service protocol: "tcp" or "udp". string string Type Specify the type of list: - black: blocked addresses - white: allowed addresses Note: This is case sensitive – the type value should be in lowercase. string string Address Specifies a host or network IP address to add to the access control list. The address can be specified in CIDR format. If the CIDR is not specified, the system uses a default of /32. string string Comment Optionally specify a comment in relation to the list entry. string string LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. string string LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. int32 int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. object object InformationAction actionpreference actionpreference InformationVariable string string CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string -------------------------- Example -------------------------- PS C:\> Add-VSPacketFilterAddr -Address 10.124.5.69 -Port 80 -Protocol tcp -Type white -VirtualService 10.154.11.181 -Comment "Example comment" Example Output: ReturnCode Response Data ---------- -------- ---- 200 Command successfully executed Get-GeoSingleFQDN Retrieve details for a specific FQDN. This command will display the settings for the specified FQDN. FQDN Specify the name of the FQDN to display the details for. string string LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. string string LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. int32 int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. object object InformationAction actionpreference actionpreference InformationVariable string string CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string -------------------------- Example -------------------------- PS C:\> Get-GeoSingleFQDN -FQDN example.com Example Output: Mapping : 0 publicRequestValue : 0 SiteRecoveryMode : auto failover : N SelectionCriteria : lb privateRequestValue : 0 Status : Up FullyQualifiedDomainName : example.com. FailTime : 0 Get-LmMiscParameter Displays the values of the miscellaneous GEO parameters. Displays the values of the miscellaneous GEO parameters. LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. string string LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. int32 int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. object object InformationAction actionpreference actionpreference InformationVariable string string CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string -------------------------- Example -------------------------- PS C:\> Get-LmMiscParameter Example Output: SourceOfAuthority : example. TTL : 100 CheckInterval : 120 Persist : 10 RetryAttempts : 2 ConnTimeout : 20 NameSrv : example. SOAEmail : example@example.com. Get-SecMultipleWebUIAccess Retrieve the value of the Allow Multi Interface Access option. If this option is enabled, WUI access is allowed from multiple interfaces. Apart from the main administrative interface, each interface can then be enabled to allow WUI access. LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. string string LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. int32 int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. object object InformationAction actionpreference actionpreference InformationVariable string string CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string -------------------------- Example -------------------------- PS C:\> Get-SecMultipleWebUIAccess Example Output: multihomedwui ------------- no Get-SecWebUIAuth Allows you to view the values of WUI Authentication and Authorization options. Allows you to view the values of WUI Authentication and Authorization options. LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. string string LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. int32 int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. object object InformationAction actionpreference actionpreference InformationVariable string string CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string -------------------------- Example -------------------------- PS C:\> Get-SecWebUIAuth Example Output: sessionlocalauth : yes radiussecret : ******** radiusbackupsecret : ******** radiusbackupport : 31 ldapbackupserver : radiusserver : 20.11.35.120 radiusbackupserver : 20.11.35.121 ldapserver : radiusport : 30 radiusrevalidateinterval : 60 ldapsecurity : 0 sessionauthmode : 0 ldaprevalidateinterval : 60 Get-SecWebUIConfiguration Allows you to view the values of WUI Configuration options. Allows you to view the values of WUI Configuration options. LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. string string LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. int32 int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. object object InformationAction actionpreference actionpreference InformationVariable string string CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string This is a legacy command and does not return all of the available parameters. Please refer to the Get-Help of the Get-Parameter command to view a full list of parameters that can be returned. -------------------------- Example -------------------------- PS C:\> Get-SecWebUIConfiguration Example Output: sessioncontrol : no sessionidletime : 70 sessionmaxfailattempts : 0 motd : Test Message hoverhelp : yes wuidisplaylines : 0 Remove-GeoCountry Allows you to remove a country assignment from a mapped IP address. Allows you to remove a country assignment from a mapped IP address. FQDN The name of the FQDN. string string IP IP address of the map to be modified. string string CountryCode Two-letter country code for the country to be unassigned. To specify everywhere as the country, type ALL as the country code and set the IsContinent parameter to yes. string string IsContinent Some country codes and continent codes are the same, for example AF could mean Africa or Afghanistan. You must specify in this parameter if the code is for a country or continent. yes – code is for a continent no – code is for a country string string CustomLocation The name of an existing custom location. string string LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. string string LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. int32 int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. object object InformationAction actionpreference actionpreference InformationVariable string string CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string This command is only relevant when the Selection Criteria is set to Location Based. -------------------------- Example -------------------------- PS C:\> Remove-GeoCountry –CountryCode <TwoCharacterCountryCode> -FQDN <FQDNName> -IP <IPAddress> -iscontinent <yes/no> Example Output: ok Remove-VSPacketFilterAddr Removes an address from the black or white list for a Virtual Service. Removes a host or network IP address from the black or white access control list for a specific Virtual Service. Note that black and white lists are only enabled when packet filtering is enabled. VirtualService Specifies the Virtual Service IP address. string string Port Specifies the Virtual Service port number. int32 int32 Protocol Specifies the Virtual Service protocol: "tcp" or "udp". string string Type Specify the type of list: - black: blocked addresses - white: allowed addresses Note: This is case sensitive – the type value should be in lowercase. string string Address Specifies a host or network IP address to remove from the access control list. The address can be specified in CIDR format. If the CIDR is not specified, the system uses a default of /32. string string LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. string string LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. int32 int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. object object InformationAction actionpreference actionpreference InformationVariable string string CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string -------------------------- Example -------------------------- PS C:\> Remove-VSPacketFilterAddr -Address 10.154.11.198 -Port 80 -Protocol tcp -Type black -VirtualService 10.154.11.171 Example Output: ok Set-GeoDNSSEC Enable/disable DNSSEC. Enable/disable DNSSEC. Enable Specify whether to enable or disable DNSSEC: 0 - disable 1 - enable boolean boolean LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. string string LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. int32 int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. object object InformationAction actionpreference actionpreference InformationVariable string string CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string -------------------------- Example -------------------------- PS C:\> Set-GeoDNSSEC -Enable 1 Example Output: ReturnCode Response Data ---------- -------- ---- 200 Command successfully executed Set-LmMiscParameter Allows you to update the miscellaneous GEO parameters. Allows you to update the miscellaneous GEO parameters. SourceOfAuthority Specify the response set for Source Of Authority requests. string string NameSrv Specify the response set for Name Server requests. string string SOAEmail Specify the response email string sent for SOA requests. string string TTL Specify the Time To Live (TTL) of the responses returned by the LoadMaster. The default value for this is 10. The range is 1-86400. string string Persist This parameter corresponds to the Stickiness field in the WUI. Specify how long a specific request will be returned to a host. string string CheckInterval Specify how often to check the devices. Range: 9-3600 Note: The interval value must be greater than the ConnTimeout value multiplied by the RetryAttempts value (Interval > Timeout * Retry + 1). This is to ensure that the next health check does not start before the previous one completes. If the timeout or retry values are increased to a value that breaks this rule, the interval value will be automatically increased. string string ConnTimeout Specify the timeout value for the check request. Range: 4-60 string string RetryAttempts Specify the number of times the check will be retried before the device is marked as failed. string string Zone Specify the zone name. string string LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. string string LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. int32 int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. object object InformationAction actionpreference actionpreference InformationVariable string string CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string -------------------------- Example -------------------------- PS C:\> Set-LmMiscParameter –CheckInterval 130 –ConnTimeout 30 –NameSrv example –Persist 20 –RetryAttempts 3 –SOAEmail example@example.com –SourceOfAuthority example –TTL 200 Example Output: SourceOfAuthority : example. TTL : 200 CheckInterval : 130 Persist : 20 RetryAttempts : 3 ConnTimeout : 30 NameSrv : example2. SOAEmail : example2@example.com. Set-SecMultipleWebUIAccess Allows you to enable access to the LoadMaster WUI from another interface address. Allows you to enable access to the LoadMaster WUI from another interface address. MultiHomedWui boolean boolean LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. string string LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. int32 int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. object object InformationAction actionpreference actionpreference InformationVariable string string CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string multi The IP address of the interface that you want to enable WUI access on. string string -------------------------- Example -------------------------- PS C:\> Set-SecMultipleWebUIAccess –multi eth0 multihomedwui ------------- yes Set-SecWebUIAuth Allows you to set the values of WUI Authentication and Authorization options. Allows you to set the values of WUI Authentication and Authorization options. LDAPServer Specifies the LDAP server to use for authentication. string string LDAPBackupServer Specifies the backup LDAP server for authentication. string string LDAPSecurity Specifies the security mode for LDAP authentication. int16 int16 LDAPRevalidateInterval Specifies how often to revalidate the authentication to the LDAP server. int16 int16 RADIUSServer Specifies the RADIUS server to use for authentication. string string RADIUSBackupServer Specifies the backup RADIUS server to use for authentication. string string RADIUSPort Specifies the TCP port for communication to the RADIUS server. int64 int64 RADIUSBackupPort Specifies the TCP port for the backup RADIUS server. int64 int64 RADIUSSecret Specifies the password (secret) to the RADIUS server. string string RADIUSBackupSecret Specifies the password (secret) to the backup RADIUS server. string string SessionLocalAuth Enables or disables local authentication. boolean boolean SessionAuthMode Specifies the authentication mode for the LoadMaster. Refer to the following table for values: RADIUS LDAP Local Value Authent. Author. Authent. Authent. Author. 7 No No No No No 263 Yes No No Yes Yes 775 Yes Yes No Yes Yes 23 No No Yes Yes Yes 22 No No Yes No Yes 788 Yes Yes Yes No No 790 Yes Yes Yes No Yes 791 Yes Yes Yes Yes Yes 789 Yes Yes Yes Yes No 773 Yes Yes No Yes No 262 Yes No No No Yes 774 Yes Yes No No Yes 772 Yes Yes No No No 278 Yes No Yes No No 279 Yes No Yes Yes Yes int16 int16 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. string string LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. int32 int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. object object InformationAction actionpreference actionpreference InformationVariable string string CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string -------------------------- Example -------------------------- PS C:\> Set-SecWebUIAuth -RADIUSBackupPort 31 -RADIUSBackupSecret testbsecret -RADIUSBackupServer 20.11.35.121 -RADIUSPort 30 -RADIUSSecret testsecret -RADIUSServer 20.11.35.120 -SessionLocalAuth $True Example Output: sessionlocalauth : yes radiussecret : ******** radiusbackupsecret : ******** radiusbackupport : 31 ldapbackupserver : radiusserver : 20.11.35.120 radiusbackupserver : 20.11.35.121 ldapserver : radiusport : 30 radiusrevalidateinterval : 60 ldapsecurity : 0 sessionauthmode : 0 ldaprevalidateinterval : 60 Set-SecWebUIConfiguration Allows you to set the values of WUI Configuration options. Allows you to set the values of WUI Configuration options. HoverHelp Enables or disables hover help in the web user interface. boolean boolean Motd Sets the Message Of The Day (MOTD) for the web user interface. Either plain text or a text file can be used. The maximum number of characters is 5,000. An error will be displayed if the MOTD is greater than 5,000 characters. string string SessionControl Enables or disables session control. boolean boolean SessionIdleTime Specifies the number of seconds that the WUI can be idle before logging the user out. This can be set from 60 to 86400 seconds. int32 int32 SessionMaxFailAttempts Number of failed attempts before locking the user account. This can be set from 1 to 999. int16 int16 StatisticsDisplaySize int16 int16 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. string string LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. int32 int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. object object InformationAction actionpreference actionpreference InformationVariable string string CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string WUIDisplayLines Specifies the number of display lines in the web user interface. This can be set from 10 to 100. int16 int16 This is a legacy command and cannot be used to set all of the available parameters. Please refer to the Get-Help of the Set-Parameter command to view a full list of parameters that can be configured. -------------------------- Example -------------------------- PS C:\> Set-SecWebUIConfiguration -HoverHelp $True -Motd "Test Message" -SessionControl $True -SessionIdleTime 70 Example Output: sessioncontrol : yes sessionidletime : 70 sessionmaxfailattempts : 0 motd : Test Message hoverhelp : yes wuidisplaylines : 0 AcceptEULA Used to enter the magic cookie key returned by the ReadEula command and to set the type of license used, for example trial, perm or free. When this command is run successfully, an explanation of the Call Home feature and magic string will be displayed. Value Name in WUI Description Trial Trial (Unrestricted) Temporary license for users evaluating the KEMP LoadMaster Perm Perpetual Purchased permanent LoadMaster Free Free (Restricted) Free LoadMaster Type Use this parameter to specify the type of license that is being employed. Valid values for the type parameter are: Perm - Perpetual Free - Free (Restricted) Trial – Trial (Unrestricted) string string Magic The key that is is generated by the ReadEULA command. string string LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. string string LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. int32 int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. object object InformationAction actionpreference actionpreference InformationVariable string string This is a legacy command and has been replaced with the Confirm-LicenseEULA command. KEMP strongly recommends using the new command instead. -------------------------- Example -------------------------- PS C:\> AcceptEULA –magic 5e614-3bp21-g6p1g-trp1g –type perm Example Output: A second magic key and an explanation of the Call Home feature is displayed. AcceptEULA2 Specify whether or not to use the Call Home feature. As part of KEMPs continuous drive to offer better value and services to our customers KEMP has introduced a Call Home feature. The LoadMaster can utilize Call Home to get available license updates, information regarding any updated firmware for your product and provide system status information to KEMP. The system status information will include Throughput, Enabled Features, Virtual Services and Real Servers details but will not include any unique personal information or actual traffic from your network. Your LoadMaster will initiate a connection to KEMP once during any 24 hour interval. NOTE – Allowing Call Home is mandatory for Free LoadMaster versions. For more details on this visit http://www.kemptechnologies.com/callhome Magic The IP Address for the KEMP LoadMaster to which the command is being directed. This key is generated by running the ReadEULA command. string string Accept This parameter is used to accept or reject the license agreement. The possible values are; yes and no. string string LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. string string LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. int32 int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. object object InformationAction actionpreference actionpreference InformationVariable string string This is a legacy command and has been replaced with the Confirm-LicenseEULA2 command. KEMP strongly recommends using the new command instead. -------------------------- Example -------------------------- PS C:\> AcceptEULA2 -Accept no -Magic 1a30e1c2-9332-4331-b932-78bf5340520c Example Output: ok Add-AdcWafRule Assigns WAF rules to the specified Virtual Service. Assigns WAF rules to the specified Virtual Service. VS The IP address of the relevant Virtual Service. string string Port Specifies the port on which this Virtual Service accepts connections. string string Prot Specifies the communication protocol of the Virtual Service. Valid options are TCP or UDP (not case sensitive). string string Rule Specify the name of the rule to be assigned. The rule name must be preceded with a letter/word and a forward slash. The letter used depends on the type of rule being added: - C or Custom - Z or ApplicationGeneric - A or ApplicationSpecific - G or Generic string string Disablerules Specific rules can be disabled per ruleset by specifying the rule IDs to be disabled. Multiple rules can be disabled by using a comma-separated list. To retrieve the rule IDs, run the Get-WAFVSRules command. To only update rules (and not rulesets), run the Add-AdcWafRule command with a blank Rule parameter. To remove all disabled rules (i.e. enable all rules), run the Add-AdcWafRule command with blank rule and disablerules parameters. string string LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. string string LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. int32 int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. object object InformationAction actionpreference actionpreference InformationVariable string string CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string The rule name must be preceded with the relevant letter/word and a forward slash. The letter/word used depends on the type of rule being assigned. This is case sensitive. The letter/word needs to be in the correct case for the command to work. • C or Custom • Z or ApplicationGeneric • A or ApplicationSpecific • G or Generic Multiple rules can be assigned in the same command by separating them with a space. An invalid rule error will display if the name of the rule is not entered correctly, if the preceding letter is incorrect, or if the does not exist in the LoadMaster. -------------------------- Example -------------------------- PS C:\> Add-AdcWafRule -Port 443 -Prot tcp -Rule G/creditcard_known -VS 10.154.11.91 Example Output: ok Add-GeoCluster Adds a new GEO cluster. Adds a new GEO cluster. IP The IP address of the GEO cluster. string string Name The name of the GEO cluster. string string LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. string string LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. int32 int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. object object InformationAction actionpreference actionpreference InformationVariable string string CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string -------------------------- Example -------------------------- PS C:\> Add-GeoCluster –IP <IPAddress> -Name <NameofCluster> Example Output: ok Add-HostsEntry Adds a host IP address and host FQDN. Add a host IP address and host FQDN HostIP Specify the IP address for the entry. string string HostFQDN Specify the host FQDN for the entry. string string LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. string string LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. int32 int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. object object InformationAction actionpreference actionpreference InformationVariable string string CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string -------------------------- Example -------------------------- PS C:\> Add-HostsEntry -HostFQDN example2.com -HostIP 10.154.11.180 Example Output: Ok Add-LdapEndpoint Add a new LDAP endpoint. These LDAP endpoints may be used in three different areas: • Health checks • SSO domains • WUI authentication Name The desired name for the new LDAP endpoint. This name cannot contain any spaces. string string Server Specify the address, or addresses, of the LDAP server to be used. You can also specify a port number, if desired. Separate multiple addresses with a space. string string LdapType Specify the transport protocol to use when communicating with the LDAP server. Valid values are: 0 – Unencrypted (default) 1 – StartTLS 2 – LDAPS int16 int16 VInterval Specify how often to revalidate the user the with the LDAP server. Range: 10 – 86400 seconds Default: 60 int16 int16 AdminUser Specify the username of an administrator user. The username that will be used to check the LDAP server. string string AdminPass Specify the password for the specified administrator user. The password that will be used to check the LDAP server. string string LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. string string LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. int32 int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. object object InformationAction actionpreference actionpreference InformationVariable string string CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string -------------------------- Example -------------------------- PS C:\> Add-LdapEndpoint -Name ExampleLDAPEndpoint -AdminPass examplepassword -AdminUser ExampleAdminUsername -LdapType 0 -Server "10.154.11.23 10.154.22.45" -VInterval 80 Example Output: ReturnCode Response Data ---------- -------- ---- 200 Command successfully executed ExampleLDAPEndpoint Add-NetworkInterfaceAddress Allows you to add an address for an interface. Allows you to add an address for an interface. InterfaceID The Interface ID to add an IP Address to. To view the interface ID for each of the interfaces, run the Get-Statistics command. The interface ID is the first number displayed in each interface row. int16 int16 Address The IP Address and CIDR (e.g. 10.1.2.3/24) to be added to the specified Interface. string string LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. string string LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. int32 int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. object object InformationAction actionpreference actionpreference InformationVariable string string CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string -------------------------- Example -------------------------- PS C:\> Add-NetworkInterfaceAddress -Address 10.11.0.210/24 -InterfaceID 0 Example Output: Ok AlsiLicense Update the LoadMaster's license online. Cause the LoadMaster to query the KEMP licensing system for an updated license. LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. string string LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. int32 int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. object object KempId The KEMP ID is the email address which was used when registering for a KEMP ID. string string Password The password of the KEMP ID account. string string http_proxy Specify the HTTP(S) proxy server and port the LoadMaster will use to access the internet. string string InformationAction actionpreference actionpreference InformationVariable string string This step must be performed before the LoadMaster password can be set. This is a legacy command and has been replaced with the Request-LicenseOnline command. KEMP strongly recommends using the new command instead. -------------------------- Example -------------------------- PS C:\> AlsiLicense -KempId jbloggs@kemptechnologies.com -Password examplepassword -LoadBalancer 10.154.11.60 Example Output: ok Export-WafCustomRule Allows you to download an AFP custom rule file. Allows you to download an AFP custom rule file. LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. string string LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. int32 int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. object object Path The path where you want to download the custom rule file to, followed by a backslash and the new name of the file.extension. string string Filename The filename of the custom rule. string string InformationAction actionpreference actionpreference InformationVariable string string CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string -------------------------- Example -------------------------- PS C:\> Export-WafCustomRule -Filename modsecurity_crs_10_ignore_static -Path C:\rules\rule1.conf Example Output: Ok Get-Hosts Lists the existing hosts for local resolution. Lists the existing hosts for local resolution. LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. string string LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. int32 int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. object object InformationAction actionpreference actionpreference InformationVariable string string CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string -------------------------- Example -------------------------- PS C:\> Get-Hosts Example Output: HostIPAddress HostFqdn ------------- -------- 10.154.11.178 example.com Get-PreviousVersion Run this command to view the previous firmware version. Run this command to view the previous firmware version. LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. string string LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. int32 int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. object object InformationAction actionpreference actionpreference InformationVariable string string CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string -------------------------- Example -------------------------- PS C:\> Get-PreviousVersion Example Output: ReturnCode Data Response ---------- ---- -------- 200 @{PreviousVersion=7.2.37.0.13610.DEV.20160905-061... Command successfully executed Get-SecSingleUser Retrieve the permissions for an individual user. The permissions for the specified user are displayed. User The username of the relevant user to display the permissions for. string string LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. string string LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. int32 int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. object object InformationAction actionpreference actionpreference InformationVariable string string CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string This is a legacy command - please use the Get-SecUser command instead. -------------------------- Example -------------------------- PS C:\> Get-KEMPSecSingleUser -User Example Name Perms ---- ----- Example ,real,rules,cer... Get-VpnConnection Retrieves a list of all existing VPN connection details, or details for a specific VPN connection. To retrieve details for a specific VPN connection, use the Name parameter to specify the name of the relevant VPN connection. To retrieve details for all VPN connections, do not use the Name parameter. Name Specify the name of a specific VPN connection to display the details for. To display details for all VPN connections - do not use this parameter. string string LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. string string LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. int32 int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. object object InformationAction actionpreference actionpreference InformationVariable string string CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string -------------------------- Example -------------------------- PS C:\> Get-VpnConnection Example Output: pfs : disabled localIP : 10.154.11.80 localID : 10.154.11.80 key : remoteIP : name : Example remoteID : status : Down remoteSubnets : localSubnets : 10.154.11.80/32 Get-VSTotals Get global summary statistics for all Virtual Services. Retrieves the total number of Virtual Services, SubVSs and Real Servers that are up, down and administratively disabled. LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. string string LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. int32 int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. object object InformationAction actionpreference actionpreference InformationVariable string string CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string -------------------------- Example -------------------------- PS C:\> Get-VSTotals Example Output: Type : VSTotals Total : 9 Up : 4 Down : 5 Disabled : 0 Type : SubVSTotals Total : 0 Up : 0 Down : 0 Disabled : 0 Type : RSTotals Total : 1 Up : 0 Down : 1 Get-WafVSRules View a list of rules and rule IDs for an active ruleset. A list of rules and their IDs will be displayed for the specified ruleset. VS The IP address of the relevant Virtual Service. string string Port The port of the relevant Virtual Service. string string Prot The protocol of the relevant Virtual Service, i.e. tcp or udp. string string Rule The name of the ruleset to display the rules for. The rule name must be preceded with the relevant letter or word and a forward slash. The letter/word used depends on the type of rule: • C or Custom • Z or ApplicationGeneric • A or ApplicationSpecific • G or Generic This is case sensitive. The letter/word needs to be in in the correct case for the command to work. string string LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. string string LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. int32 int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. object object InformationAction actionpreference actionpreference InformationVariable string string CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string -------------------------- Example -------------------------- PS C:\> Get-WafVSRules -Port 443 -Prot tcp -Rule G/owasp_protocol_violations -VS 10.154.11.102 Example Output: ActiveRule1 : 960020:OWASP_CRS/PROTOCOL_VIOLATION/INVALID_HREQ:Pragma Header requires Cache-Control Header for HTTP/1.1 requests. ActiveRule2 : 958291:OWASP_CRS/PROTOCOL_VIOLATION/INVALID_HREQ:Range: field exists and begins with 0. ActiveRule3 : 958230:OWASP_CRS/PROTOCOL_VIOLATION/INVALID_HREQ:Range: Invalid Last Byte Value. ActiveRule4 : 958231:OWASP_CRS/PROTOCOL_VIOLATION/INVALID_HREQ:Range: Too many fields ActiveRule5 : 958295:OWASP_CRS/PROTOCOL_VIOLATION/INVALID_HREQ:Multiple/Conflicting Connection Header Data Found. ActiveRule6 : 950107:OWASP_CRS/PROTOCOL_VIOLATION/EVASION:URL Encoding Abuse Attack Attempt ActiveRule7 : 950109:OWASP_CRS/PROTOCOL_VIOLATION/EVASION:Multiple URL Encoding Detected ActiveRule8 : 950108:OWASP_CRS/PROTOCOL_VIOLATION/EVASION:URL Encoding Abuse Attack Attempt ActiveRule9 : 950801:OWASP_CRS/PROTOCOL_VIOLATION/EVASION:UTF8 Encoding Abuse Attack Attempt ActiveRule10 : 950116:(null):Unicode Full/Half Width Abuse Attack Attempt ActiveRule11 : 960901:OWASP_CRS/PROTOCOL_VIOLATION/EVASION:Invalid character in request ActiveRule12 : 960018:OWASP_CRS/PROTOCOL_VIOLATION/EVASION:Invalid character in request Initialize-Lm Allows you to globally set the LoadMaster IP address and login credentials for the PowerShell session. Allows you to globally set the LoadMaster IP address and login credentials for the PowerShell session. These details can be overridden on individual commands by using the LoadBalancer and Credential parameters. Address Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. string string LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. int32 int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. object object InformationAction actionpreference actionpreference InformationVariable string string CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string If the API interface is disabled on the LoadMaster, running this command will enable it. -------------------------- Example -------------------------- PS C:\> Initialize-Lm –Address <LoadMasterIPAddress> -Credential bal Example Output: Unless overridden using a local -LoadBalancer parameter, all commands will now be directed to 10.11.0.60. Unless overridden using a local -Credential parameter, all commands will now use bal. IsAPIEnabled Check if the API interface is enabled on the LoadMaster. The results will display whether or not the API interface is enabled. The LoadMaster firmware version is also displayed. LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. string string LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. int32 int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. object object InformationAction actionpreference actionpreference InformationVariable string string This is a legacy command and has been replaced by the Test-SecAPIAccess command. KEMP strongly recommends using the new command instead. -------------------------- Example -------------------------- PS C:\> IsAPIEnabled Example Output: API is Enabled version ------- 7.1.36.0.13179.DEV New-AdcVirtualServerRule Allows you to add a preconfigured rule to a Virtual Service. Allows you to add a preconfigured rule to a Virtual Service or SubVS. RuleType Specifies if the rule is a pre-processing rule, a response rule, or a request rule. Valid options are "pre", "response", and "request". string string VirtualService Specifies the IP Address of the Virtual Service that this rule should be applied to. string string Port Specifies the port on which the Virtual Service accepts connections. int32 int32 Protocol Specifies the communication protocol. Valid options are TCP or UDP. string string VSIndex The VSIndex number of the relevant Virtual Service or SubVS. To retrieve the VSIndex, run the Get-VirtualService command. int32 int32 RuleName The name of the rule that should be set on this Virtual Service. string string LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. string string LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. int32 int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. object object InformationAction actionpreference actionpreference InformationVariable string string CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string -------------------------- Example -------------------------- PS C:\> New-AdcVirtualServerRule -Port 80 -Protocol tcp -RealServer 10.11.0.24 -RSPort 80 -RuleName TestRule1 -RuleType pre -VirtualService 10.11.0.200 Example Output: ok New-SubVirtualService Create a new Sub-Virtual Service. Creates a new Sub-Virtual Service by identifying the parent Virtual Service by its IP address, port and protocol. VirtualService The IP address of the parent Virtual Service. string string Port The port of the parent Virtual Service. int32 int32 Protocol The protocol of the parent Virtual Service. string string LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. string string LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. int32 int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. object object InformationAction actionpreference actionpreference InformationVariable string string CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string -------------------------- Example -------------------------- PS C:\> New-SubVirtualService -Port 80 -Protocol tcp -VirtualService 172.20.0.209 Example Output: Status : Down Index : 1 VSAddress : 172.20.0.209 VSPort : 80 Enable : Y SSLReverse : N SSLReencrypt : N Intercept : N InterceptOpts : InterceptOpts AlertThreshold : 0 Transactionlimit : 0 Transparent : Y SubnetOriginating : N ServerInit : 0 StartTLSMode : 0 Idletime : 0 Cache : N Compress : N Verify : 0 UseforSnat : N ForceL7 : Y MultiConnect : N ClientCert : 0 ErrorCode : 0 CertFile : bd665e52e39df817a0e88a9bec7c3c95 CheckUrl : /healthcheck.htm CheckUse1.1 : N MatchLen : 0 CheckUseGet : 1 SSLRewrite : 0 VStype : http FollowVSID : 0 Protocol : tcp Schedule : rr CheckType : https PersistTimeout : 360 SSLAcceleration : Y CheckPort : 443 NRules : 0 NRequestRules : 0 NResponseRules : 0 NPreProcessRules : 0 EspEnabled : N InputAuthMode : 0 OutputAuthMode : 0 MasterVS : 1 MasterVSID : 0 AddVia : 0 QoS : 0 TlsType : 1 NeedHostName : N OCSPVerify : N RsMinimum : 0 CipherSet : Default NumberOfRSs : 1 SubVS : SubVS New-SubVirtualServiceByID Create a new Sub-Virtual Service. Creates a new Sub-Virtual Service by identifying the parent Virtual Service by its Virtual Service index. VSIndex The index number of the parent Virtual Service. int32 int32 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. string string LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. int32 int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. object object InformationAction actionpreference actionpreference InformationVariable string string CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string -------------------------- Example -------------------------- PS C:\> New-SubVirtualServiceByID -VSIndex 4 Example Output: Status : Down Index : 4 VSAddress : 172.20.0.237 VSPort : 80 Enable : Y SSLReverse : N SSLReencrypt : N Intercept : N InterceptOpts : InterceptOpts AlertThreshold : 0 Transactionlimit : 0 Transparent : Y SubnetOriginating : N ServerInit : 0 StartTLSMode : 0 Idletime : 0 Cache : N Compress : N Verify : 0 UseforSnat : N ForceL7 : Y MultiConnect : N ClientCert : 0 ErrorCode : 0 CheckUse1.1 : N MatchLen : 0 CheckUseGet : 0 SSLRewrite : 0 VStype : http FollowVSID : 0 Protocol : tcp Schedule : rr CheckType : http PersistTimeout : 0 CheckPort : 0 NRules : 0 NRequestRules : 0 NResponseRules : 0 NPreProcessRules : 0 EspEnabled : N InputAuthMode : 0 OutputAuthMode : 0 MasterVS : 1 MasterVSID : 0 AddVia : 0 QoS : 0 TlsType : 0 NeedHostName : N OCSPVerify : N RsMinimum : 0 NumberOfRSs : 1 SubVS : SubVS New-VpnConnection Creates a new VPN connection Creates a new VPN connection Name The name of the VPN. string string LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. string string LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. int32 int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. object object InformationAction actionpreference actionpreference InformationVariable string string CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string -------------------------- Example -------------------------- PS C:\> New-VpnConnection -Name ExampleVPN Example Output: status defaultLocalIP defaultLocalSubnet defaultLocalID ------ -------------- ------------------ -------------- Down 10.11.0.10 10.11.0.10/32 10.11.0.10 ReadEULA Displays the EULA and a magic cookie. The End User License Agreement (EULA) and magic cookie will be displayed. LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. string string LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. int32 int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. object object InformationAction actionpreference actionpreference InformationVariable string string This is a legacy command and has been replaced with the Read-LicenseEULA command. KEMP strongly recommends using the new command instead. -------------------------- Example -------------------------- PS C:\> ReadEULA –LoadBalancer 10.154.11.60 Example Output: The output displays a magic key, for example <Magic>98d10cca-b721-4378-b5be-e8c458ec7214</Magic> and the LoadMaster End User License Agreement (EULA). Remove-AdcVirtualServiceByID Remove a Virtual Service by its Virtual Service ID. Removes a Virtual Service with the specified Virtual Service ID. This is the only way in which a SubVS can be removed using the PowerShell API, because SubVSs do not have IP addresses. To find out the Virtual Service ID, run the Get-VirtualService command without any parameters. VSIndex The index number of the Virtual Service. int32 int32 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. string string LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. int32 int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. object object InformationAction actionpreference actionpreference InformationVariable string string CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string Force Enable this parameter to force the command to execute without a confirmation. switchparameter switchparameter WhatIf Enable this parameter to see what the command will do without actually executing the command. switchparameter switchparameter Confirm Confirms that the action should be carried out. switchparameter switchparameter -------------------------- Example -------------------------- PS C:\> Remove-AdcVirtualServiceByID -VSIndex 2 Example Output: ok Remove-AdcWafRule Un-assigns an AFP rule from the specified Virtual Service. Un-assigns an AFP rule from the specified Virtual Service. VS The IP address of the relevant Virtual Service. string string Port Specifies the port on which this Virtual Service accepts connections. string string Prot Specifies the communication protocol of the Virtual Service. Valid options are TCP or UDP. string string Rule Specify the name of the rule to be unassigned. The rule name must be preceded with a letter/word and a forward slash. The letter used depends on the type of rule being added: - C or Custom - Z or ApplicationGeneric - A or ApplicationSpecific - G or Generic string string LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. string string LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. int32 int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. object object InformationAction actionpreference actionpreference InformationVariable string string CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string The rule name must be preceded with the relevant letter/word and a forward slash. The letter/word used depends on the type of rule being added: • C or Custom • Z or ApplicationGeneric • A or ApplicationSpecific • G or Generic -------------------------- Example -------------------------- PS C:\> Remove-AdcWafRule -VS 10.11.0.31 -Port 80 -Prot tcp -Rule C/modsecurity_crs_11_brute_force Example Output: ok Remove-NetworkInterfaceAddress Allows you to remove an address from an interface. Allows you to remove an address from an interface. InterfaceID The interface ID that should be removed from the LoadMaster. To view the interface ID for each of the interfaces, run the Get-Statistics command. The interface ID is the first number displayed in each interface row. int16 int16 Address The IP address of the interface. string string LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. string string LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. int32 int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. object object Force Enable this parameter to force the command to execute without a confirmation. switchparameter switchparameter InformationAction actionpreference actionpreference InformationVariable string string WhatIf Enable this parameter to see what the command will do without actually executing the command. switchparameter switchparameter Confirm Confirms that the action should be carried out. switchparameter switchparameter CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string -------------------------- Example -------------------------- PS C:\> Remove-NetworkInterfaceAddress -InterfaceID 0 -Address 172.21.56.121/24 Example Output: Mtu : 1500 InterfaceType : Port Id : 0 DefaultInterface : yes GeoTrafficEnable : yes IPAddress : 172.21.56.120/24 Remove-VpnConnection Deletes an existing VPN connection. Deletes an existing VPN connection. Name The name of the VPN. string string LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. string string LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. int32 int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. object object InformationAction actionpreference actionpreference InformationVariable string string CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string -------------------------- Example -------------------------- PS C:\> Remove-VpnConnection -Name ExampleVpn Example Output: Ok SetInitialPasswd Set the password of the default bal LoadMaster user, during initial configuration. During initial configuration of the LoadMaster, this command can be used to set the password of the default bal user. Passwd This is the password for the default administrator user (bal). The password should contain at least 8 alphanumeric characters. string string LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. string string LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. int32 int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. object object InformationAction actionpreference actionpreference InformationVariable string string This is a legacy command and has been replaced with Set-LicenseInitialPassword. -------------------------- Example -------------------------- PS C:\> SetInitialPassword –Passwd examplepassword Example Output: ok Update-License Update the LoadMaster's license using the offline method. A BLOB is required to license a LoadMaster using the offline method. BLOBs are emailed to customers when requested. The BLOB is the body of text from the word begin to the word end in the email. Copy and paste this text into a text file. This file must be uploaded when running this command in order to successfully license the LoadMaster. Path The local path to the license file to upload. Use the Get-AccessKey command to get the key to use to generate a license from KEMP Technologies. This parameter is required. string string LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. string string LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. int32 int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. object object InformationAction actionpreference actionpreference InformationVariable string string -------------------------- Example -------------------------- PS C:\> Update-License -Path c:\license\license.txt Example Output: ok Update-WafIDSRules Allows you to update the Intrusion Detection ruleset. Allows you to update the Intrusion Detection ruleset. Path The local path to the IDS rules file. This file should be a .tar.gz file. string string LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. string string LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. int32 int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. object object InformationAction actionpreference actionpreference InformationVariable string string CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string -------------------------- Example -------------------------- PS C:\> Update-WafIDSRules -Path c:\IDSRules\community.rules.tar Example Output: ok Set-LmBackupSecureIndentity Upload the SSH private key generated on the remote scp server. If using scp (1) as the backupsecure method, the remote identity value must be provided. This is the SSH private key generated using ssh-keygen on the remote scp server. Path The file path to the private key file. string string LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. string string LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. int32 int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. object object InformationAction actionpreference actionpreference InformationVariable string string CertificateStoreLocation This parameter is optional. If you do not use it, the cmdlet searches for the certificate in the default Cert:\CurrentUser\My location. If the CertificateStoreLocation parameter is set, the API searches for the certificate in the specified location, for example, Cert:\<CurrentUser>\TrustedPeople. Note: The CertificateStoreLocation can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the CertificateStoreLocation field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string SubjectCN This parameter is mandatory if you want to use certificate-based authentication. Specify the certificate Common Name (CN), which is the username of the LoadMaster user that the certificate was generated for. If you do not specify the CertificateStoreLocation, the certificate is searched for in the default Cert:\CurrentUser\My location. Note: The SubjectCN can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the SubjectCN field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. string string -------------------------- Example -------------------------- PS C:\> Set-LmBackupSecureIndentity -Path C:\Users\ExampleUser\Desktop\Work\PowerShell\pdata Example Output: ok SetWafAutoInstall Allows you to enable/disable the automatic installation of commercial AFP rules. Allows you to enable/disable the automatic installation of commercial AFP rules. Enable Enable or disable the commercial AFP automatic rule install. 0 - Disable 1 - Enable string string InformationAction actionpreference actionpreference InformationVariable string string Does the same thing as the EnableWafAutoInstall command. This is a legacy command and has been replaced with the Set-WafRulesAutoUpdateConfiguration command. -------------------------- Example -------------------------- PS C:\> SetWafAutoInstall –Enable 1 Example Output: ok Switch-ClusterHAUnit Allows you to set the values of High Availability (HA) options. Allows you to set the values of High Availability (HA) options. LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. string string LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. int32 int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. object object InformationAction actionpreference actionpreference InformationVariable string string -------------------------- Example -------------------------- PS C:\> Switch-ClusterHAUnit -LoadBalancer 10.11.0.35 Example Command: (This is a legacy command and should no longer be used.) Restore-LmLoadBalancer Restore the LoadMaster using a backup file already saved. Restore the LoadMaster using a backup file already saved. LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. string string LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. int32 int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. object object Path The local path to the backup file. string string Type The type of information to restore. string string InformationAction actionpreference actionpreference InformationVariable string string -------------------------- Example -------------------------- PS C:\> Restore-LoadBalancer -Path C:\backups\LMBackups_2013_11_04.17_43 -Type Base Example Output: ok Set-LicenseInitialPasswd Used to set the password of the default bal LoadMaster user during initial configuration. Used to set the password of the default bal LoadMaster user during initial configuration. Passwd This is the password for the default administrator user (bal). The password should contain at least 8 alphanumeric characters. string string LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. string string Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. object object InformationAction actionpreference actionpreference InformationVariable string string -------------------------- Example -------------------------- PS C:\> Set-LicenseInitialPasswd –Passwd examplepassword Example Output: ok Add-NetworkBondedInterfae Adds a standalone interface to a bonded interface. Adds a standalone interface to a bonded interface. InterfaceID The Interface ID that should be bound to the Bonded Interface. To view the interface ID for each of the interfaces, run the Get-Statistics command. The interface ID is the first number displayed in each interface row. int16 int16 BondID The Bonded Interface ID that the network interface should be bound to. int16 int16 LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. string string LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. int32 int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. pscredential pscredential InformationAction actionpreference actionpreference InformationVariable string string -------------------------- Example -------------------------- PS C:\> Add-NetworkBondedInterfae -BondID 0 -InterfaceID 0 Example Output: Mtu : 1500 InterfaceType : Bonded Id : 1 DefaultInterface : no BondMembers : 1,2 GeoTrafficEnable : no NBondMembers : 2 Mode : 802.3ad IPAddress : 172.22.56.102/24 Add-GeoIPRange Allows you to add an IP address to the IP range selection criteria list. Allows you to add an IP address to the IP range selection criteria list. IP IP address of the IP range. string string LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. string string Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. object object InformationAction actionpreference actionpreference InformationVariable string string -------------------------- Example -------------------------- PS C:\> Add-GeoIPRange <IPAddress> Example Output: Ok Backup-TlsCertificateStore Allows you create a backup of all the certificates and intermediate certificates on the LoadMaster. Allows you create a backup of all the certificates and intermediate certificates on the LoadMaster. The password will be required to restore the certificate file to the load balancer. Password A password to encrypt the certificate backup file. This password will be needed to restore the certificate file to the LoadMaster. string string Path The local path where the certificate backup file should be saved. If no file is specified, the backup file will be saved as C:\Temp\CertificateBackup_yyyy-MM-dd_HH-mm-ss, assuming that C:\ is the System Root drive specified in the Environment variables. string string LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. string string LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. int32 int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. object object InformationAction actionpreference actionpreference InformationVariable string string -------------------------- Example -------------------------- PS C:\> Backup-TlsCertificateStore -Password password -Path C:\temp Example Output: Ok Test-SecMultipleWebUIAccess Informs you if the WUI can be accessed via multiple interfaces or not. Informs you if the WUI can be accessed via multiple interfaces or not. loadbalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. string string credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. object object InformationAction actionpreference actionpreference InformationVariable string string -------------------------- Example -------------------------- PS C:\> Test-SecMultipleWebUIAccess Example Output: multihomedwui ------------- yes ListClusters WARNING: This function is deprecated. Use the following command instead: Get-GeoCluster WARNING: This function is deprecated. Use the following command instead: Get-GeoCluster LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. string string Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. object object InformationAction actionpreference actionpreference InformationVariable string string -------------------------- Example -------------------------- PS C:\> ListClusters Example Output: Enable : Y LocationLatitude : 0.01666667 Type : default LocationLongitude : 0.01666667 ClusterVSAddress : Checker : none Name : Example Index : 1 Status : Up CheckerPort : 80 IPAddress : 10.154.11.55 Get-Templates Returns a list of any templates that exist on the LoadMaster. Returns a list of any templates that exist on the LoadMaster. LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. string string Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. object object InformationAction actionpreference actionpreference InformationVariable string string -------------------------- Example -------------------------- PS C:\> Get-Templates Example Output: comment certified name ------- --------- ---- Handles Storage Connector to Atmos (Version 1.0) yes AtmosREST Handles Syncplicity Https (Version 1.0) yes Syncplicity Set-GeoLocation Allows you to install an updated GEO database patch file. Allows you to install an updated GEO database patch file. Path The path to the patch file in the format path\filename.extension string string LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. string string LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. int32 int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. object object InformationAction actionpreference actionpreference InformationVariable string string -------------------------- Example -------------------------- PS C:\> Set-GeoLocation –Path <Path\Filename.extension> Example Output: Ok Set-ClusterAwsHAOption Allows you to set the other AWS HA options: health check port and partner address. Allows you to set the other AWS HA options: health check port and partner address. Partner Address of the HA partner. string string Hcp The port over which the health check is run. This needs to be the same on both the master and the slave units in order for HA to function correctly. string string LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. string string Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. object object InformationAction actionpreference actionpreference InformationVariable string string -------------------------- Example -------------------------- PS C:\> Set-ClusterAwsHAOption –Hcp 443 –Partner <PartnerIPAddress> Example Output: ok ShowFQDN Displays the details of a specific FQDN. Displays the details of a specific FQDN. FQDN The name of the FQDN. string string LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. string string Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. object object InformationAction actionpreference actionpreference InformationVariable string string -------------------------- Example -------------------------- PS C:\> ShowFQDN –FQDN <FQDNName> Example Output: Mapping : 1 2 SiteRecoveryMode : manual Map : Down,1,10.11.0.12,Test,AS,EU,clust,80,10.11.0.14,1000,10.11.0.11,80,N,0.00000000,0.00000000,Up,2,10.11.0.23,Test,icmp,0,1000,Y,0.0 0000000,0.00000000 failover : Y SelectionCriteria : rr Status : Up FullyQualifiedDomainName : example.com. FailTime : 1920 UserDeleteCert Delete a local user's certificate. Delete a local user's certificate file on the LoadMaster. User Name of local user. string string LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. string string LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. int32 int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. object object InformationAction actionpreference actionpreference InformationVariable string string -------------------------- Example -------------------------- PS C:\> UserDeleteCert -User ExampleUser Example Output: ok UserDownloadCert Download a local user's certificate. Download a local user's certificate file from the LoadMaster. User Name of local user. string string Path Path to store certificate file. string string LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. string string LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. int32 int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. object object InformationAction actionpreference actionpreference InformationVariable string string -------------------------- Example -------------------------- PS C:\> UserDownloadCert -Path C:\ExampleCert\ExampleCertName.pem -User ExampleUser Example Output: There is no output displayed but the file should be downloaded to the specified location. UserGenerateCert Generate a certificate for a local user. Generate (or regenerate if one already exists) a certificate for a local user on the LoadMaster. User Name of local user. string string Passphrase Optional passphrase for certificate. string string LoadBalancer Specify the address of the LoadMaster to run the command on. Note: The LoadMaster address can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LoadBalancer field when running a command, unless you want to overwrite it. string string LBPort Specify the port to communicate with the LoadMaster on. Note: The LoadMaster port can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the LBPort field when running a command, unless you want to overwrite it. int32 int32 Credential The username to connect to the LoadMaster with. Note: The username can be specified for the session by using the Initialize-LmConnectionParameters command. If this is done, there is no need to fill out the Credential field when running a command, unless you want to overwrite it. When running PowerShell commands, either authenticate using the username (Credential) and password, or use certificate-based authentication by using the CertificateStoreLocation and SubjectCN parameters. object object InformationAction actionpreference actionpreference InformationVariable string string -------------------------- Example -------------------------- PS C:\> UserGenerateCert -User ExampleUser -Passphrase ExamplePassphrase Example Output: ok