All Superinterfaces:: Maskable, ResultLimitable, Service

Enclosing class:: Gateway

@ApiService("SoftLayer_Network_Gateway")
public static interface Gateway.Service
extends Service

A network gateway is a set of members which have a configurable set of VLANs trunked through them. This is helpful for creating proxies. Each network gateway can have a configurable set of hardware and VLANs within the same pod routed to it. Gateways can be bypassed or unbypassed either as a whole or for specific VLANs. They are also provided gateway VLANs for management that are never bypassed. Members cannot be simply removed once attached to a gateway, they must be reclaimed.

See Also:: SoftLayer_Network_Gateway

Method Summary

Modifier and Type	Method	Description
`Gateway.ServiceAsync`	`asAsync()`	Get an async version of this service
`Void`	`bypassAllVlans()`	Start the asynchronous process to bypass all VLANs.
`Void`	`bypassVlans(List<Vlan> vlans)`	Start the asynchronous process to bypass the provided VLANs.
`Boolean`	`changeGatewayVersion(Long versionId, Boolean rollbackVersion)`	Used to create a transaction to upgrade or rollback the vSRX version for Juniper gateway.
`Boolean`	`checkAccountWhiteList(Long accountId, String category)`
`Gateway`	`createObject(Gateway templateObject)`	Create and return a new gateway.
`Boolean`	`editObject(Gateway templateObject)`	Edit this gateway.
`Account`	`getAccount()`	The account for this gateway.
`List<Long>`	`getAllowedOsPriceIds(Long memberId)`	Used to get a list of OS prices (ids) which are allowed for the Gateway.
`String`	`getCapacity()`	Returns the Gbps capacity of the gateway object
`List<Vlan>`	`getInsideVlans()`	All VLANs trunked to this gateway.
`String`	`getManufacturer(Boolean checkSameOs, Boolean checkOsReloadMember)`	Returns manufacturer name for a given gateway object.
`Boolean`	`getMemberGatewayImagesMatch()`	Returns true if no mismatch is found, gateway is not Juniper vSRX or SA gateway
`List<Member>`	`getMembers()`	The members for this gateway.
`Firewall`	`getNetworkFirewall()`	The firewall associated with this gateway, if any.
`Boolean`	`getNetworkFirewallFlag()`	Whether or not there is a firewall associated with this gateway.
`Gateway`	`getObject()`
`List<Vlan>`	`getPossibleInsideVlans()`	Get all VLANs that can become inside VLANs on this gateway.
`IpAddress`	`getPrivateIpAddress()`	The private gateway IP address.
`Vlan`	`getPrivateVlan()`	The private VLAN for accessing this gateway.
`IpAddress`	`getPublicIpAddress()`	The public gateway IP address.
`IpAddress`	`getPublicIpv6Address()`	The public gateway IPv6 address.
`Vlan`	`getPublicVlan()`	The public VLAN for accessing this gateway.
`String`	`getRollbackSupport()`	Returns the following statuses SUPPORTED - rollback is supported and perform automatically UNSUPPORTED - rollback is not supported MANUAL - rollback can be performed but
`Status`	`getStatus()`	The current status of the gateway.
`List<Price>`	`getUpgradeItemPrices()`	Retrieve a list of upgradable items available for network gateways.
`Boolean`	`isAccountWhiteListed(String category)`
`Boolean`	`isLicenseServerAllowed(String licenseKeyName)`
`Boolean`	`isRollbackAllowed()`	Returns true if rollback is allowed.
`Boolean`	`rebuildvSRXHACluster()`	Rebuild a vSRX gateway with HA cluster by destroying existing vSRX and installing new vSRX on both gateway servers, then creating HA cluster between 2 vSRX.
`Boolean`	`setGatewayPassword(String password)`	Returns true if password change is successful, false if not successful
`void`	`setMask(Gateway.Mask mask)`
`Void`	`unbypassAllVlans()`	Start the asynchronous process to unbypass all VLANs.
`Void`	`unbypassVlans(List<Vlan> vlans)`	Start the asynchronous process to unbypass the provided VLANs.
`Gateway.Mask`	`withMask()`	Use the existing mask on this service or create it if not present
`Gateway.Mask`	`withNewMask()`	Overwrite the existing mask on this service with a new one and return it

Methods inherited from interface com.softlayer.api.Maskable

clearMask, setMask, setMask

Methods inherited from interface com.softlayer.api.ResultLimitable

getLastResponseTotalItemCount, getResultLimit, setResultLimit

Method Details
- asAsync
  
  Gateway.ServiceAsync asAsync()
  
  Description copied from interface: Service
  
  Get an async version of this service
  
  Specified by:
  
  asAsync in interface Service
- withNewMask
  
  Gateway.Mask withNewMask()
  
  Description copied from interface: Maskable
  
  Overwrite the existing mask on this service with a new one and return it
  
  Specified by:
  
  withNewMask in interface Maskable
- withMask
  
  Gateway.Mask withMask()
  
  Description copied from interface: Maskable
  
  Use the existing mask on this service or create it if not present
  
  Specified by:
  
  withMask in interface Maskable
- setMask
  
  void setMask(Gateway.Mask mask)
- bypassAllVlans
  
  @ApiMethod(instanceRequired=true) Void bypassAllVlans()
  
  Start the asynchronous process to bypass all VLANs. Any VLANs that are already bypassed will be ignored. The status field can be checked for progress.
  
  See Also:
  
  SoftLayer_Network_Gateway::bypassAllVlans
- bypassVlans
  
  @ApiMethod(instanceRequired=true) Void bypassVlans(List<Vlan> vlans)
  
  Start the asynchronous process to bypass the provided VLANs. The VLANs must already be attached. Any VLANs that are already bypassed will be ignored. The status field can be checked for progress.
  
  See Also:
  
  SoftLayer_Network_Gateway::bypassVlans
- changeGatewayVersion
  
  @ApiMethod(instanceRequired=true) Boolean changeGatewayVersion(Long versionId, Boolean rollbackVersion)
  
  Used to create a transaction to upgrade or rollback the vSRX version for Juniper gateway.
  
  See Also:
  
  SoftLayer_Network_Gateway::changeGatewayVersion
- checkAccountWhiteList
  
  @ApiMethod Boolean checkAccountWhiteList(Long accountId, String category)
  
  See Also:
  
  SoftLayer_Network_Gateway::checkAccountWhiteList
- createObject
  
  @ApiMethod Gateway createObject(Gateway templateObject)
  
  Create and return a new gateway. This object can be created with any number of members or VLANs, but they all must be in the same pod. By creating a gateway with members and/or VLANs attached, it is the equivalent of individually calling their createObject methods except this will start a single asynchronous process to setup the gateway. The status of this process can be checked using the status field.
  
  See Also:
  
  SoftLayer_Network_Gateway::createObject
- editObject
  
  @ApiMethod(instanceRequired=true) Boolean editObject(Gateway templateObject)
  
  Edit this gateway. Currently, the only value that can be edited is the name.
  
  See Also:
  
  SoftLayer_Network_Gateway::editObject
- getAllowedOsPriceIds
  
  @ApiMethod(instanceRequired=true) List<Long> getAllowedOsPriceIds(Long memberId)
  
  Used to get a list of OS prices (ids) which are allowed for the Gateway.
  
  See Also:
  
  SoftLayer_Network_Gateway::getAllowedOsPriceIds
- getCapacity
  
  @ApiMethod(instanceRequired=true) String getCapacity()
  
  Returns the Gbps capacity of the gateway object
  
  See Also:
  
  SoftLayer_Network_Gateway::getCapacity
- getManufacturer
  
  @ApiMethod(instanceRequired=true) String getManufacturer(Boolean checkSameOs, Boolean checkOsReloadMember)
  
  Returns manufacturer name for a given gateway object.
  
  See Also:
  
  SoftLayer_Network_Gateway::getManufacturer
- getMemberGatewayImagesMatch
  
  @ApiMethod(instanceRequired=true) Boolean getMemberGatewayImagesMatch()
  
  Returns true if no mismatch is found, gateway is not Juniper vSRX or SA gateway
  
  See Also:
  
  SoftLayer_Network_Gateway::getMemberGatewayImagesMatch
- getObject
  
  @ApiMethod(instanceRequired=true) Gateway getObject()
  
  See Also:
  
  SoftLayer_Network_Gateway::getObject
- getPossibleInsideVlans
  
  @ApiMethod(instanceRequired=true) List<Vlan> getPossibleInsideVlans()
  
  Get all VLANs that can become inside VLANs on this gateway. This means the VLAN must not already be an inside VLAN, on the same router as this gateway, not a gateway transit VLAN, and not firewalled.
  
  See Also:
  
  SoftLayer_Network_Gateway::getPossibleInsideVlans
- getRollbackSupport
  
  @ApiMethod(instanceRequired=true) String getRollbackSupport()
  
  Returns the following statuses SUPPORTED - rollback is supported and perform automatically UNSUPPORTED - rollback is not supported MANUAL - rollback can be performed but
  
  See Also:
  
  SoftLayer_Network_Gateway::getRollbackSupport
- getUpgradeItemPrices
  
  @ApiMethod(instanceRequired=true) List<Price> getUpgradeItemPrices()
  
  Retrieve a list of upgradable items available for network gateways.
  
  See Also:
  
  SoftLayer_Network_Gateway::getUpgradeItemPrices
- isAccountWhiteListed
  
  @ApiMethod(instanceRequired=true) Boolean isAccountWhiteListed(String category)
  
  See Also:
  
  SoftLayer_Network_Gateway::isAccountWhiteListed
- isLicenseServerAllowed
  
  @ApiMethod(instanceRequired=true) Boolean isLicenseServerAllowed(String licenseKeyName)
  
  See Also:
  
  SoftLayer_Network_Gateway::isLicenseServerAllowed
- isRollbackAllowed
  
  @ApiMethod(instanceRequired=true) Boolean isRollbackAllowed()
  
  Returns true if rollback is allowed.
  
  See Also:
  
  SoftLayer_Network_Gateway::isRollbackAllowed
- rebuildvSRXHACluster
  
  @ApiMethod(instanceRequired=true) Boolean rebuildvSRXHACluster()
  
  Rebuild a vSRX gateway with HA cluster by destroying existing vSRX and installing new vSRX on both gateway servers, then creating HA cluster between 2 vSRX. This is a destructive process which will remove existing vSRX configuration and stop all gateway capabilities. vSRX will need to be re-configured after this operation.
  
  See Also:
  
  SoftLayer_Network_Gateway::rebuildvSRXHACluster
- setGatewayPassword
  
  @ApiMethod(instanceRequired=true) Boolean setGatewayPassword(String password)
  
  Returns true if password change is successful, false if not successful
  
  See Also:
  
  SoftLayer_Network_Gateway::setGatewayPassword
- unbypassAllVlans
  
  @ApiMethod(instanceRequired=true) Void unbypassAllVlans()
  
  Start the asynchronous process to unbypass all VLANs. Any VLANs that are already unbypassed will be ignored. The status field can be checked for progress.
  
  See Also:
  
  SoftLayer_Network_Gateway::unbypassAllVlans
- unbypassVlans
  
  @ApiMethod(instanceRequired=true) Void unbypassVlans(List<Vlan> vlans)
  
  Start the asynchronous process to unbypass the provided VLANs. The VLANs must already be attached. Any VLANs that are already unbypassed will be ignored. The status field can be checked for progress.
  
  See Also:
  
  SoftLayer_Network_Gateway::unbypassVlans
- getAccount
  
  @ApiMethod(instanceRequired=true) Account getAccount()
  
  The account for this gateway.
  
  See Also:
  
  SoftLayer_Network_Gateway::getAccount
- getInsideVlans
  
  @ApiMethod(instanceRequired=true) List<Vlan> getInsideVlans()
  
  All VLANs trunked to this gateway.
  
  See Also:
  
  SoftLayer_Network_Gateway::getInsideVlans
- getMembers
  
  @ApiMethod(instanceRequired=true) List<Member> getMembers()
  
  The members for this gateway.
  
  See Also:
  
  SoftLayer_Network_Gateway::getMembers
- getNetworkFirewall
  
  @ApiMethod(instanceRequired=true) Firewall getNetworkFirewall()
  
  The firewall associated with this gateway, if any.
  
  See Also:
  
  SoftLayer_Network_Gateway::getNetworkFirewall
- getNetworkFirewallFlag
  
  @ApiMethod(instanceRequired=true) Boolean getNetworkFirewallFlag()
  
  Whether or not there is a firewall associated with this gateway.
  
  See Also:
  
  SoftLayer_Network_Gateway::getNetworkFirewallFlag
- getPrivateIpAddress
  
  @ApiMethod(instanceRequired=true) IpAddress getPrivateIpAddress()
  
  The private gateway IP address.
  
  See Also:
  
  SoftLayer_Network_Gateway::getPrivateIpAddress
- getPrivateVlan
  
  @ApiMethod(instanceRequired=true) Vlan getPrivateVlan()
  
  The private VLAN for accessing this gateway.
  
  See Also:
  
  SoftLayer_Network_Gateway::getPrivateVlan
- getPublicIpAddress
  
  @ApiMethod(instanceRequired=true) IpAddress getPublicIpAddress()
  
  The public gateway IP address.
  
  See Also:
  
  SoftLayer_Network_Gateway::getPublicIpAddress
- getPublicIpv6Address
  
  @ApiMethod(instanceRequired=true) IpAddress getPublicIpv6Address()
  
  The public gateway IPv6 address.
  
  See Also:
  
  SoftLayer_Network_Gateway::getPublicIpv6Address
- getPublicVlan
  
  @ApiMethod(instanceRequired=true) Vlan getPublicVlan()
  
  The public VLAN for accessing this gateway.
  
  See Also:
  
  SoftLayer_Network_Gateway::getPublicVlan
- getStatus
  
  @ApiMethod(instanceRequired=true) Status getStatus()
  
  The current status of the gateway.
  
  See Also:
  
  SoftLayer_Network_Gateway::getStatus

Interface Gateway.Service

Method Summary

Methods inherited from interface com.softlayer.api.Maskable

Methods inherited from interface com.softlayer.api.ResultLimitable

Method Details