Core API 7.8

net.juniper.smgt.sae.portal
Class DhcpProfile

java.lang.Object
  extended by net.juniper.smgt.sae.portal.DhcpProfile

public class DhcpProfile
extends java.lang.Object

Encapsulate DHCP Profile data used to manipulate DHCP addresses for JUNOSe version 5.3 and later.


Constructor Summary
DhcpProfile()
           
 
Method Summary
 java.lang.String getBootFileName()
          Gets the value of bootFileName Set the value of the "file" field in the DHCP message.
 java.lang.String getDhcpOptions()
          Gets the value of dhcpOptions Set the value of the "options" field in the DHCP message.
 int getLeaseTime()
          Gets the value of leaseTime.
 java.lang.String getRadiusClass()
          Gets the value of radiusClass
 int getRadiusFramedIpAddress()
          Gets the value of radiusFramedIpAddress The attribute radiusFramedIpAddress is one of the possible selectors for a DHCP address pool.
 java.lang.String getRadiusFramedPool()
          Gets the value of radiusFramedPool The attribute radiusFramedPool is one of the possible selectors for a DHCP address pool.
 java.lang.String getServerName()
          Gets the value of serverName Set the value of the "sname" field in the DHCP message.
 java.lang.String getServiceBundle()
          Gets the value of serviceBundle
 java.lang.String getUserName()
          Gets the value of userName
 java.lang.String getVirtualRouterName()
          Gets the value of virtualRouterName The attribute is used to select the virtual router context in which the DHCP address will be managed.
 void setBootFileName(java.lang.String argBootFileName)
          Sets the value of bootFileName
 void setDhcpOptions(java.lang.String argDhcpOptions)
          Sets the value of dhcpOptions
 void setLeaseTime(int argLeaseTime)
          Sets the value of leaseTime
 void setRadiusClass(java.lang.String argRadiusClass)
          Sets the value of radiusClass
 void setRadiusFramedIpAddress(int argRadiusFramedIpAddress)
          Sets the value of radiusFramedIpAddress
 void setRadiusFramedPool(java.lang.String argRadiusFramedPool)
          Sets the value of radiusFramedPool
 void setServerName(java.lang.String argServerName)
          Sets the value of serverName
 void setServiceBundle(java.lang.String argServiceBundle)
          Sets the value of serviceBundle
 void setUserName(java.lang.String argUserName)
          Sets the value of userName
 void setVirtualRouterName(java.lang.String argVirtualRouterName)
          Sets the value of virtualRouterName
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

DhcpProfile

public DhcpProfile()
Method Detail

getRadiusFramedPool

public java.lang.String getRadiusFramedPool()
Gets the value of radiusFramedPool

The attribute radiusFramedPool is one of the possible selectors for a DHCP address pool. The attribute has to match the name of a configured pool on the E-series router.

DHCP addresses are selected based on the following criteria:

  1. radiusFramedPool
  2. radiusFramedIpAddress
  3. domainName the domain name is taken from the login request itself, it is not part of the DhcpProfile.

Returns:
the value of radiusFramedPool

setRadiusFramedPool

public void setRadiusFramedPool(java.lang.String argRadiusFramedPool)
Sets the value of radiusFramedPool

Parameters:
argRadiusFramedPool - Value to assign to this.radiusFramedPool
See Also:
getRadiusFramedPool()

getRadiusFramedIpAddress

public int getRadiusFramedIpAddress()
Gets the value of radiusFramedIpAddress

The attribute radiusFramedIpAddress is one of the possible selectors for a DHCP address pool. The attribute identifies a fixed IP address which will be offered to the DHCP client, if it is part of a network in configured DHCP pool.

DHCP addresses are selected based on the following criteria:

  1. radiusFramedIpAddress
  2. radiusFramedIpAddress
  3. domainName the domain name is taken from the login request itself, it is not part of the DhcpProfile.

Returns:
the value of radiusFramedIpAddress

setRadiusFramedIpAddress

public void setRadiusFramedIpAddress(int argRadiusFramedIpAddress)
Sets the value of radiusFramedIpAddress

Parameters:
argRadiusFramedIpAddress - Value to assign to this.radiusFramedIpAddress
See Also:
getRadiusFramedIpAddress()

getVirtualRouterName

public java.lang.String getVirtualRouterName()
Gets the value of virtualRouterName

The attribute is used to select the virtual router context in which the DHCP address will be managed.

Returns:
the value of virtualRouterName

setVirtualRouterName

public void setVirtualRouterName(java.lang.String argVirtualRouterName)
Sets the value of virtualRouterName

Parameters:
argVirtualRouterName - Value to assign to this.virtualRouterName
See Also:
getVirtualRouterName()

getLeaseTime

public int getLeaseTime()
Gets the value of leaseTime.

Set the length of the DHCP lease in seconds.

Note: not all versions of JUNOSe honor this setting. please check your JUNOSe documenation for details.

Returns:
the value of leaseTime

setLeaseTime

public void setLeaseTime(int argLeaseTime)
Sets the value of leaseTime

Parameters:
argLeaseTime - Value to assign to this.leaseTime
See Also:
getLeaseTime()

getServerName

public java.lang.String getServerName()
Gets the value of serverName

Set the value of the "sname" field in the DHCP message. See RFC2131 for details of this field.

Note: not all versions of JUNOSe honor this setting. please check your JUNOSe documenation for details.

Returns:
the value of serverName

setServerName

public void setServerName(java.lang.String argServerName)
Sets the value of serverName

Parameters:
argServerName - Value to assign to this.serverName
See Also:
getServerName()

getBootFileName

public java.lang.String getBootFileName()
Gets the value of bootFileName

Set the value of the "file" field in the DHCP message. See RFC2131 for details of this field.

Note: not all versions of JUNOSe honor this setting. please check your JUNOSe documenation for details.

Returns:
the value of bootFileName

setBootFileName

public void setBootFileName(java.lang.String argBootFileName)
Sets the value of bootFileName

Parameters:
argBootFileName - Value to assign to this.bootFileName
See Also:
getBootFileName()

getDhcpOptions

public java.lang.String getDhcpOptions()
Gets the value of dhcpOptions

Set the value of the "options" field in the DHCP message. Field is a string containg one or more options defined as "name=value". Multiple options are separated by line breaks. "names" are defined in the file etc/dhcp.options. Unknown options can be entered as "option-###", where ### is the code number identifying the option. "value" is a value of the appropriate type.

See RFC2132 for details of DHCP options.

Example: the following setting will set the DHCP options for the DNS server, the domain name, the WINS server and "option-50".

 domain-name-servers=192.168.1.10, 192.168.1.20\n
 domain-name="virneo.com"\n
 netbios-name-servers=192.168.1.10, 192.168.1.20\n
 option-50=11:22:33:aa:bb:cc:dd:ee
 

Note: not all versions of JUNOSe honor this setting. please check your JUNOSe documenation for details.

Returns:
the value of dhcpOptions

setDhcpOptions

public void setDhcpOptions(java.lang.String argDhcpOptions)
Sets the value of dhcpOptions

Parameters:
argDhcpOptions - Value to assign to this.dhcpOptions
See Also:
getDhcpOptions()

getUserName

public java.lang.String getUserName()
Gets the value of userName

Returns:
the value of userName

setUserName

public void setUserName(java.lang.String argUserName)
Sets the value of userName

Parameters:
argUserName - Value to assign to this.userName

getServiceBundle

public java.lang.String getServiceBundle()
Gets the value of serviceBundle

Returns:
the value of serviceBundle

setServiceBundle

public void setServiceBundle(java.lang.String argServiceBundle)
Sets the value of serviceBundle

Parameters:
argServiceBundle - Value to assign to this.serviceBundle

getRadiusClass

public java.lang.String getRadiusClass()
Gets the value of radiusClass

Returns:
the value of radiusClass

setRadiusClass

public void setRadiusClass(java.lang.String argRadiusClass)
Sets the value of radiusClass

Parameters:
argRadiusClass - Value to assign to this.radiusClass

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

Core API 7.8