The host object represents a Quarantined Host entry in SMS Quarantine.
This object has dynamic properties that can pass information. The special dynamic
property
EditRADIUS allows the SMS RADIUS proxy to edit RADIUS responses for this host. This is how switch
disconnect and move to VLAN actions operate with RADIUS enforcement. The host object
also contains the dynamic properties
SWITCH_IP and
SWITCH_PORT if IP Correlation succeeded.
Properties
| Name | Type | Description |
| id | long | The quarantined host ID. |
| ingressSwitch | Device | The switch, if IP Correlation succeeded. |
| ip | String | The quarantined IP address. |
| macAsInt | long | The MAC address of the end station expressed as a long value. This property is provided, in conjunction with the method int2mac() to allow alternate formatting of the MAC address. |
| macIfKnown | String | The MAC address of the end station if IP correlation succeeded. |
Methods
| Return Value | Name | Description |
| Callback | callbackOnEvent( String eventType , String scriptName ) | Registers a script to invoke when an event occurs on this quarantined host. See Event for the valid values of eventType . |
| Callback | callbackOnState( String stateName , String scriptName ) | Registers a script to invoke when this quarantined host transitions to the specified state. Since no script is invoked before the quarantined host is in the QUARANTINED state, the only effective values for stateName are UNQUARANTINED and ERROR. |
| boolean | isQuarantined() | Returns whether the quarantined host entry is currently in quarantine. |
| boolean | isUnquarantined() | Returns whether the quarantined host entry is currently unquarantined. |
| Callback[] | searchCallbacks( Integer eventID ) | Returns an array of callbacks registered for this quarantined host entry. If eventID is not null, it will only return callbacks registered by that event. |
Sample usage
host.callbackOnState( 'UNQUARANTINED', 'doUnquarantine’ );