Overview Package Class Deprecated Help

wpp
WppHost

Represents information about a particular WPP portal.

public class WppHost

Properties
creationOrigin

type=svt.L2RouteOriginType
access=read-create
default=manual
hostSvcId Indicates the service ID of the service to which this WPP host belongs

type=long
access=read-only
hostSvcSitePointer Pointer to the service to which this WPP host belongs

type=Pointer
default=
Displayed(tab/group)=Host Service
ipAddress The IP address of this WPP host

type=InetAddress
access=read-create
default=0.0.0.0
Displayed(tab/group)=IP Address
ipAddressType The IP address type for this WPP host

type=rtr.InetAddressType
access=read-create
default=ipv4
lClAddrType The IP address type for lClAddress

type=rtr.InetAddressType
access=read-create
default=ipv4
lClAddress Indicates the destination IP address used by the portal while sending WPP protocol messages about this host to this system.

type=InetAddress
access=read-create
Mandatory on create
Displayed(tab/group)=Destination IP address
macAddress Indicates the MAC address of this WPP host

type=MacAddress
access=read-create
default=00-00-00-00-00-00
Displayed(tab/group)=MAC Address
portalName

type=string
access=read-create
Mandatory on create
remotePort Indicates the UDP source port used by the portal while sending WPP protocol messages about this host to this system. The value zero indicates that the port is not yet known

type=long
access=read-create
Mandatory on create
Displayed(tab/group)=Remote UDP Port
requestId Indicates the request ID of the WPP host. The value zero indicates that the request ID is unknown or irrelevant

type=long
access=read-create
Mandatory on create
Displayed(tab/group)=Request ID
routerId

type=int
access=read-only
default=1
minimum=1
maximum=10240
serialNumber Indicates the serial number of the WPP host. The value zero indicates that the serial number is unknown or irrelevant.

type=long
access=read-create
Mandatory on create
Displayed(tab/group)=Serial Number
serviceId Indicates the service ID of the service to which this WPP host belongs."

type=long
access=read-only
default=0
siteId

type=string
access=read-only
default=
maximum=64
status Indicates the state of the WPP host

type=wpp.WppHostStatus
access=read-create
Mandatory on create
Displayed(tab/group)=Status
userName Indicates the WPP user name of this WPP host."

type=string
access=read-create
Mandatory on create
Displayed(tab/group)=User Name
wppHostIsMCBackup Indicates whether the WPP host is on the MCS backup node or not

type=boolean
access=read-only
Displayed(tab/group)=WPP MCS Backup
wppHostIsTriggered Indicates whether the creation of the host is triggered by the portal. If the host creation is not triggered by the portal, wppHostIsTriggered value is FALSE.

type=boolean
access=read-only
Displayed(tab/group)=WPP Triggered Host
wppHostTrackSrrpInst Indicates the SRRP instance whose state is tracked by this WPP host to determine if it is on the MCS master or backup node

type=long
access=read-only
Displayed(tab/group)=WPP Track SRRP Instance
  
Properties inherited from ManagedObject
actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed
 
Methods

requestClearWppHostsLoggingOut

Request clearing the logging out WPP host(s) with the specified parameters. The siteId is required. The svcId should be 0 for base routing instance or the ID of the VPRN service. When this method returns resources for the clear have been allocated but the clear has not been performed yet. To retrieve the result eventually, use the returned request handle as input param of the retrieveClearRequest method of the clear.ClearCommandManager.
Input Parameters:
deployer : Deployer - the deployment state
synchronousDeploy : boolean - (Optional) Specify whether to block until the changes have been fully deployed to the network. A value of "true" means to block. A value of "false" means to return immediately. Default: false (asynchronous)
clearOnDeployFailure : boolean - (Optional) Specify whether to clear any failed deployers. A value of "true" means to clear. A value of "false" means to leave the failed deployer. Default: false
deployRetries : int - (Optional) The number of times to attempt re-deployment during synchronous deployment. This parameter is meaningless in the asynchronous case. Default: 0
deployRetryInterval : long - (Optional) The number of milliseconds to wait between deployment retries. This parameter is meaningless in the asynchronous case. Default: 0
taskDescription : string - (Optional) A user friendly description of what the operation does. This information will be used by the task manager.
clearWppHostsLoggingOutConfig : wpp.ClearWppHostsLoggingOutStruct - clearWppHostsLoggingOutConfig of WPP Host with desired serviceId and IP address whose values are used to be cleared. The configuration objects must have set siteId and serviceId.
resultFilter : ResultFilter - (Optional) Filter for narrowing down the information returned per object
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Output Parameters:
aOutResult : clear.RequestHandleStruct - A request handle which allows the retrieval of the request (and its result when it becomes available) through the ClearCommandManager's retrieveClearRequest method.
Exceptions:
wpp.WppHost.requestClearWppHostsLoggingOutException
Supported Network Elements
7750 SR Supported from 10.0.R1
7450 ESS Supported from 10.0.R1
Product Specifics
7450 ESS 20.0
7450 ESS 21.0
7450 ESS 22.0
7450 ESS 23.0
7450 ESS 24.0
7450 ESS 25.0
7750 SR 20.0
7750 SR 21.0
7750 SR 22.0
7750 SR 23.0
7750 SR 24.0
7750 SR 25.0