Package com.softlayer.api.service.account.lockdown

Interface Request.Service

All Superinterfaces:

Maskable, ResultLimitable, Service

Enclosing class:

Request

@ApiService("SoftLayer_Account_Lockdown_Request")
public static interface Request.Service
extends Service

This service allows approved brands the ability to disconnect, reconnect, and disable customer accounts under that brand. Brand customers are able to make requests on their customers through an API call to this service.

Disconnecting a customer will disable all hardware resources (servers and virtual machines) via a lockdown event. The customer will continue to have control portal access as well as access to their private ports.

Reconnecting a customer will restore all previously disconnected public access. The original lockdown event will be closed.

Disabling an account is a PERMANENT action. All billable items under the account will be canceled, access to the control portal, all resources, network access and hardware will be permanently disabled and reclaimed.

See Also:

SoftLayer_Account_Lockdown_Request

Method Summary

Modifier and Type	Method	Description
Request.ServiceAsync	asAsync()	Get an async version of this service
Void	cancelRequest()	Will cancel a lockdown request scheduled in the future.
Long	disableLockedAccount(String disableDate)	Takes the original lockdown request ID, and an optional disable date.
Long	disconnectCompute(Long accountId, String disconnectDate)	Takes an account ID and an optional disconnect date.
List<Request>	getAccountHistory(Long accountId)	Provides a history of an account's lockdown requests and their status.
Request	getObject()
Long	reconnectCompute(String reconnectDate)	Takes the original disconnected lockdown event ID, and an optional reconnect date.
void	setMask(Request.Mask mask)
Request.Mask	withMask()	Use the existing mask on this service or create it if not present
Request.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

Request.ServiceAsync asAsync()

Description copied from interface: Service

Get an async version of this service

Specified by:

asAsync in interface Service

withNewMask

Request.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

Request.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(Request.Mask mask)

cancelRequest

@ApiMethod(instanceRequired=true)
Void cancelRequest()

Will cancel a lockdown request scheduled in the future. Once canceled, the lockdown request cannot be reconciled and new requests must be made for subsequent actions on the account.

See Also:

SoftLayer_Account_Lockdown_Request::cancelRequest

disableLockedAccount

@ApiMethod(instanceRequired=true)
Long disableLockedAccount(String disableDate)

Takes the original lockdown request ID, and an optional disable date. If no date is passed with the API call, the account will be disabled immediately. Otherwise, the account will be disabled on the date given. All hardware will be reclaimed and all accounts permanently disabled.

See Also:

SoftLayer_Account_Lockdown_Request::disableLockedAccount

disconnectCompute

@ApiMethod
Long disconnectCompute(Long accountId,
String disconnectDate)

Takes an account ID and an optional disconnect date. If no disconnect date is passed into the API call, the account disconnection will happen immediately. Otherwise, the account disconnection will happen on the date given. A brand account request ID will be returned and will then be updated when the disconnection occurs.

See Also:

SoftLayer_Account_Lockdown_Request::disconnectCompute

getAccountHistory

@ApiMethod
List<Request> getAccountHistory(Long accountId)

Provides a history of an account's lockdown requests and their status.

See Also:

SoftLayer_Account_Lockdown_Request::getAccountHistory

getObject

@ApiMethod(instanceRequired=true)
Request getObject()

See Also:

SoftLayer_Account_Lockdown_Request::getObject

reconnectCompute

@ApiMethod(instanceRequired=true)
Long reconnectCompute(String reconnectDate)

Takes the original disconnected lockdown event ID, and an optional reconnect date. If no reconnect date is passed with the API call, the account reconnection will happen immediately. Otherwise, the account reconnection will happen on the date given. The associated lockdown event will be unlocked and closed at that time.

See Also:

SoftLayer_Account_Lockdown_Request::reconnectCompute