Interface SecurityModule750.Service
- All Superinterfaces:
Hardware.Service
,Maskable
,ResultLimitable
,SecurityModule.Service
,Server.Service
,Service
- Enclosing class:
- SecurityModule750
@ApiService("SoftLayer_Hardware_SecurityModule750") public static interface SecurityModule750.Service extends SecurityModule.Service
- See Also:
- SoftLayer_Hardware_SecurityModule750
-
Method Summary
Modifier and Type Method Description SecurityModule750.ServiceAsync
asAsync()
Get an async version of this serviceSecurityModule750
createObject(SecurityModule750 templateObject)
.create_object > li > div { padding-top: .5em; padding-bottom: .5em}
createObject() enables the creation of servers on an account.SecurityModule750
getObjectForSecurityModule750()
void
setMask(SecurityModule750.Mask mask)
SecurityModule750.Mask
withMask()
Use the existing mask on this service or create it if not presentSecurityModule750.Mask
withNewMask()
Overwrite the existing mask on this service with a new one and return itMethods inherited from interface com.softlayer.api.service.Hardware.Service
allowAccessToNetworkStorage, allowAccessToNetworkStorageList, captureImage, createObject, deleteObject, deleteSoftwareComponentPasswords, deleteTag, editSoftwareComponentPasswords, executeRemoteScript, findByIpAddress, generateOrderTemplate, getAccount, getActiveComponents, getActiveNetworkMonitorIncident, getAllowedHost, getAllowedNetworkStorage, getAllowedNetworkStorageReplicas, getAllPowerComponents, getAntivirusSpywareSoftwareComponent, getAttachedNetworkStorages, getAttributes, getAvailableNetworkStorages, getAverageDailyPublicBandwidthUsage, getBackendIncomingBandwidth, getBackendNetworkComponents, getBackendOutgoingBandwidth, getBackendRouters, getBandwidthAllocation, getBandwidthAllotmentDetail, getBenchmarkCertifications, getBillingItem, getBillingItemFlag, getBlockCancelBecauseDisconnectedFlag, getBusinessContinuanceInsuranceFlag, getChildrenHardware, getComponentDetailsXML, getComponents, getContinuousDataProtectionSoftwareComponent, getCreateObjectOptions, getCurrentBillableBandwidthUsage, getCurrentBillingDetail, getCurrentBillingTotal, getDailyAverage, getDatacenter, getDatacenterName, getDaysInSparePool, getDownlinkHardware, getDownlinkNetworkHardware, getDownlinkServers, getDownlinkVirtualGuests, getDownstreamHardwareBindings, getDownstreamNetworkHardware, getDownstreamNetworkHardwareWithIncidents, getDownstreamServers, getDownstreamVirtualGuests, getDriveControllers, getEvaultNetworkStorage, getFirewallServiceComponent, getFixedConfigurationPreset, getFrontendIncomingBandwidth, getFrontendNetworkComponents, getFrontendOutgoingBandwidth, getFrontendRouters, getGlobalIdentifier, getHardDrives, getHardwareChassis, getHardwareFunction, getHardwareFunctionDescription, getHardwareStatus, getHasTrustedPlatformModuleBillingItemFlag, getHostIpsSoftwareComponent, getHourlyBandwidth, getHourlyBillingFlag, getInboundBandwidthUsage, getInboundPublicBandwidthUsage, getLastTransaction, getLatestNetworkMonitorIncident, getLocation, getLocationPathString, getLockboxNetworkStorage, getManagedResourceFlag, getMemory, getMemoryCapacity, getMetricTrackingObject, getModules, getMonitoringServiceComponent, getMotherboard, getNetworkCards, getNetworkComponents, getNetworkGatewayMember, getNetworkGatewayMemberFlag, getNetworkManagementIpAddress, getNetworkMonitorAttachedDownHardware, getNetworkMonitorAttachedDownVirtualGuests, getNetworkMonitorIncidents, getNetworkMonitors, getNetworkStatus, getNetworkStatusAttribute, getNetworkStorage, getNetworkVlans, getNextBillingCycleBandwidthAllocation, getNotesHistory, getNvRamCapacity, getNvRamComponentModels, getObject, getOperatingSystem, getOperatingSystemReferenceCode, getOutboundBandwidthUsage, getOutboundPublicBandwidthUsage, getParentBay, getParentHardware, getPointOfPresenceLocation, getPowerComponents, getPowerSupply, getPrimaryBackendIpAddress, getPrimaryBackendNetworkComponent, getPrimaryIpAddress, getPrimaryNetworkComponent, getPrivateBandwidthData, getPrivateNetworkOnlyFlag, getProcessorCoreAmount, getProcessorPhysicalCoreAmount, getProcessors, getPublicBandwidthData, getRack, getRaidControllers, getRecentEvents, getRemoteManagementAccounts, getRemoteManagementComponent, getResourceConfigurations, getResourceGroupMemberReferences, getResourceGroupRoles, getResourceGroups, getRouters, getScaleAssets, getSecurityScanRequests, getSensorData, getSensorDataWithGraphs, getServerFanSpeedGraphs, getServerPowerState, getServerRoom, getServerTemperatureGraphs, getServiceProvider, getSoftwareComponents, getSparePoolBillingItem, getSshKeys, getStorageGroups, getStorageNetworkComponents, getTagReferences, getTopLevelLocation, getTransactionHistory, getUpgradeItemPrices, getUpgradeRequest, getUplinkHardware, getUplinkNetworkComponents, getUserData, getVirtualChassis, getVirtualChassisSiblings, getVirtualHost, getVirtualizationPlatform, getVirtualLicenses, getVirtualRack, getVirtualRackId, getVirtualRackName, importVirtualHost, isPingable, ping, powerCycle, powerOff, powerOn, rebootDefault, rebootHard, rebootSoft, removeAccessToNetworkStorage, removeAccessToNetworkStorageList, removeTags, setMask, setTags
Methods inherited from interface com.softlayer.api.ResultLimitable
getLastResponseTotalItemCount, getResultLimit, setResultLimit
Methods inherited from interface com.softlayer.api.service.hardware.SecurityModule.Service
createObject, getObjectForSecurityModule, setMask
Methods inherited from interface com.softlayer.api.service.hardware.Server.Service
activatePrivatePort, activatePublicPort, bootToRescueLayer, createFirmwareReflashTransaction, createFirmwareUpdateTransaction, createHyperThreadingUpdateTransaction, createObject, createPostSoftwareInstallTransaction, editObject, getActiveNetworkFirewallBillingItem, getActiveTickets, getActiveTransaction, getActiveTransactions, getAvailableMonitoring, getAverageDailyBandwidthUsage, getAverageDailyPrivateBandwidthUsage, getBackendBandwidthUsage, getBackendBandwidthUse, getBandwidthForDateRange, getBandwidthImage, getBillingCycleBandwidthUsage, getBillingCyclePrivateBandwidthUsage, getBillingCyclePublicBandwidthUsage, getBiosPasswordNullFlag, getBootModeOptions, getCaptureEnabledFlag, getContainsSolidStateDrivesFlag, getControlPanel, getCost, getCurrentBandwidthSummary, getCurrentBenchmarkCertificationResultFile, getCustomBandwidthDataByDate, getCustomerInstalledOperatingSystemFlag, getCustomerOwnedFlag, getFirewallProtectableSubnets, getFrontendBandwidthUsage, getFrontendBandwidthUse, getHardwareByIpAddress, getHasSingleRootVirtualizationBillingItemFlag, getInboundPrivateBandwidthUsage, getIsCloudReadyNodeCertified, getIsIpmiDisabled, getIsVirtualPrivateCloudNode, getItemPricesFromSoftwareDescriptions, getLastOperatingSystemReload, getLogicalVolumeStorageGroups, getManagementNetworkComponent, getMetricTrackingObjectId, getMonitoringUserNotification, getNetworkComponentFirewallProtectableIpAddresses, getObjectForServer, getOpenCancellationTicket, getOutboundPrivateBandwidthUsage, getOverBandwidthAllocationFlag, getPMInfo, getPrimaryDriveSize, getPrivateBandwidthDataSummary, getPrivateBandwidthGraphImage, getPrivateIpAddress, getPrivateNetworkComponent, getPrivateVlan, getPrivateVlanByIpAddress, getProjectedOverBandwidthAllocationFlag, getProjectedPublicBandwidthUsage, getProvisionDate, getPublicBandwidthDataSummary, getPublicBandwidthGraphImage, getPublicBandwidthTotal, getPublicNetworkComponent, getPublicVlan, getPublicVlanByHostname, getReadyNodeFlag, getRecentRemoteManagementCommands, getRegionalInternetRegistry, getRemoteManagement, getRemoteManagementUsers, getReverseDomainRecords, getSensorDataForServer, getSensorDataWithGraphsForServer, getServerDetails, getServerFanSpeedGraphsForServer, getServerPowerStateForServer, getServerTemperatureGraphsForServer, getSoftwareGuardExtensionEnabled, getStatisticsRemoteManagement, getUefiBootFlag, getUsers, getValidBlockDeviceTemplateGroups, getVirtualGuests, getWindowsUpdateAvailableUpdates, getWindowsUpdateInstalledUpdates, getWindowsUpdateStatus, initiateIderaBareMetalRestore, initiateR1SoftBareMetalRestore, isBackendPingable, isPingableForServer, isWindowsServer, massFirmwareReflash, massFirmwareUpdate, massHyperThreadingUpdate, massReloadOperatingSystem, massSparePool, pingForServer, populateServerRam, powerCycleForServer, powerOffForServer, powerOnForServer, rebootDefaultForServer, rebootHardForServer, rebootSoftForServer, reloadCurrentOperatingSystemConfiguration, reloadOperatingSystem, runPassmarkCertificationBenchmark, setMask, setOperatingSystemPassword, setPrivateNetworkInterfaceSpeed, setPublicNetworkInterfaceSpeed, setUserMetadata, shutdownPrivatePort, shutdownPublicPort, sparePool, testRaidAlertService, toggleManagementInterface, updateIpmiPassword, validatePartitionsForOperatingSystem
-
Method Details
-
asAsync
SecurityModule750.ServiceAsync asAsync()Description copied from interface:Service
Get an async version of this service- Specified by:
asAsync
in interfaceHardware.Service
- Specified by:
asAsync
in interfaceSecurityModule.Service
- Specified by:
asAsync
in interfaceServer.Service
- Specified by:
asAsync
in interfaceService
-
withNewMask
SecurityModule750.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 interfaceHardware.Service
- Specified by:
withNewMask
in interfaceMaskable
- Specified by:
withNewMask
in interfaceSecurityModule.Service
- Specified by:
withNewMask
in interfaceServer.Service
-
withMask
SecurityModule750.Mask withMask()Description copied from interface:Maskable
Use the existing mask on this service or create it if not present- Specified by:
withMask
in interfaceHardware.Service
- Specified by:
withMask
in interfaceMaskable
- Specified by:
withMask
in interfaceSecurityModule.Service
- Specified by:
withMask
in interfaceServer.Service
-
setMask
-
createObject
createObject() enables the creation of servers on an account. This
method is a simplified alternative to interacting with the ordering system directly.
In order to create a server, a template object must be sent in with a few required
values.
When this method returns an order will have been placed for a server of the specified configuration.
To determine when the server is available you can poll the server via [[SoftLayer_Hardware/getObject|getObject]],
checking theprovisionDate
property.
WhenprovisionDate
is not null, the server will be ready. Be sure to use theglobalIdentifier
as your initialization parameter.
Warning: Servers created via this method will incur charges on your account. For testing input parameters see [[SoftLayer_Hardware/generateOrderTemplate|generateOrderTemplate]].
Input - [[SoftLayer_Hardware (type)|SoftLayer_Hardware]]
hostname
Hostname for the server.- Required
- Type - string
domain
Domain for the server.- Required
- Type - string
processorCoreAmount
The number of logical CPU cores to allocate.- Required
- Type - int
- See [[SoftLayer_Hardware/getCreateObjectOptions|getCreateObjectOptions]] for available options.
memoryCapacity
The amount of memory to allocate in gigabytes.- Required
- Type - int
- See [[SoftLayer_Hardware/getCreateObjectOptions|getCreateObjectOptions]] for available options.
hourlyBillingFlag
Specifies the billing type for the server.- Required
- Type - boolean
- When true the server will be billed on hourly usage, otherwise it will be billed on a monthly basis.
operatingSystemReferenceCode
An identifier for the operating system to provision the server with.- Required
- Type - string
- See [[SoftLayer_Hardware/getCreateObjectOptions|getCreateObjectOptions]] for available options.
datacenter.name
Specifies which datacenter the server is to be provisioned in.- Required
- Type - string
- The
datacenter
property is a [[SoftLayer_Location (type)|location]] structure with thename
field set. - See [[SoftLayer_Hardware/getCreateObjectOptions|getCreateObjectOptions]] for available options.
{
"datacenter": {
"name": "dal05"
}
}
networkComponents.maxSpeed
Specifies the connection speed for the server's network components.- Optional
- Type - int
- Default - The highest available zero cost port speed will be used.
- Description - The
networkComponents
property is an array with a single [[SoftLayer_Network_Component (type)|network component]] structure. ThemaxSpeed
property must be set to specify the network uplink speed, in megabits per second, of the server. - See [[SoftLayer_Hardware/getCreateObjectOptions|getCreateObjectOptions]] for available options.
{
"networkComponents": [
{
"maxSpeed": 1000
}
]
}
networkComponents.redundancyEnabledFlag
Specifies whether or not the server's network components should be in redundancy groups.- Optional
- Type - bool
- Default -
false
- Description - The
networkComponents
property is an array with a single [[SoftLayer_Network_Component (type)|network component]] structure. When theredundancyEnabledFlag
property is true the server's network components will be in redundancy groups.
{
"networkComponents": [
{
"redundancyEnabledFlag": false
}
]
}
privateNetworkOnlyFlag
Specifies whether or not the server only has access to the private network- Optional
- Type - boolean
- Default -
false
- When true this flag specifies that a server is to only have access to the private network.
primaryNetworkComponent.networkVlan.id
Specifies the network vlan which is to be used for the frontend interface of the server.- Optional
- Type - int
- Description - The
primaryNetworkComponent
property is a [[SoftLayer_Network_Component (type)|network component]] structure with thenetworkVlan
property populated with a [[SoftLayer_Network_Vlan (type)|vlan]] structure. Theid
property must be set to specify the frontend network vlan of the server.
{
"primaryNetworkComponent": {
"networkVlan": {
"id": 1
}
}
}
primaryBackendNetworkComponent.networkVlan.id
Specifies the network vlan which is to be used for the backend interface of the server.- Optional
- Type - int
- Description - The
primaryBackendNetworkComponent
property is a [[SoftLayer_Network_Component (type)|network component]] structure with thenetworkVlan
property populated with a [[SoftLayer_Network_Vlan (type)|vlan]] structure. Theid
property must be set to specify the backend network vlan of the server.
{
"primaryBackendNetworkComponent": {
"networkVlan": {
"id": 2
}
}
}
fixedConfigurationPreset.keyName
- Optional
- Type - string
- Description - The
fixedConfigurationPreset
property is a [[SoftLayer_Product_Package_Preset (type)|fixed configuration preset]] structure. ThekeyName
property must be set to specify preset to use. - If a fixed configuration preset is used
processorCoreAmount
,memoryCapacity
andhardDrives
properties must not be set. - See [[SoftLayer_Hardware/getCreateObjectOptions|getCreateObjectOptions]] for available options.
{
"fixedConfigurationPreset": {
"keyName": "SOME_KEY_NAME"
}
}
userData.value
Arbitrary data to be made available to the server.- Optional
- Type - string
- Description - The
userData
property is an array with a single [[SoftLayer_Hardware_Attribute (type)|attribute]] structure with thevalue
property set to an arbitrary value. - This value can be retrieved via the [[SoftLayer_Resource_Metadata/getUserMetadata|getUserMetadata]] method from a request originating from the server. This is primarily useful for providing data to software that may be on the server and configured to execute upon first boot.
{
"userData": [
{
"value": "someValue"
}
]
}
hardDrives
Hard drive settings for the server- Optional
- Type - SoftLayer_Hardware_Component
- Default - The largest available capacity for a zero cost primary disk will be used.
- Description - The
hardDrives
property is an array of [[SoftLayer_Hardware_Component (type)|hardware component]] structures.
- Each hard drive must specify the
capacity
property. - See [[SoftLayer_Hardware/getCreateObjectOptions|getCreateObjectOptions]] for available options.
{
"hardDrives": [
{
"capacity": 500
}
]
}
sshKeys
SSH keys to install on the server upon provisioning.- Optional
- Type - array of [[SoftLayer_Security_Ssh_Key (type)|SoftLayer_Security_Ssh_Key]]
- Description - The
sshKeys
property is an array of [[SoftLayer_Security_Ssh_Key (type)|SSH Key]] structures with theid
property set to the value of an existing SSH key. - To create a new SSH key, call [[SoftLayer_Security_Ssh_Key/createObject|createObject]] on the [[SoftLayer_Security_Ssh_Key]] service.
- To obtain a list of existing SSH keys, call [[SoftLayer_Account/getSshKeys|getSshKeys]] on the [[SoftLayer_Account]] service.
{
"sshKeys": [
{
"id": 123
}
]
}
postInstallScriptUri
Specifies the uri location of the script to be downloaded and run after installation is complete.- Optional
- Type - string
REST Example
curl -X POST -d '{
"parameters":[
{
"hostname": "host1",
"domain": "example.com",
"processorCoreAmount": 2,
"memoryCapacity": 2,
"hourlyBillingFlag": true,
"operatingSystemReferenceCode": "UBUNTU_LATEST"
}
]
}' https://api.softlayer.com/rest/v3/SoftLayer_Hardware.json
HTTP/1.1 201 Created
Location: https://api.softlayer.com/rest/v3/SoftLayer_Hardware/f5a3fcff-db1d-4b7c-9fa0-0349e41c29c5/getObject
{
"accountId": 232298,
"bareMetalInstanceFlag": null,
"domain": "example.com",
"hardwareStatusId": null,
"hostname": "host1",
"id": null,
"serviceProviderId": null,
"serviceProviderResourceId": null,
"globalIdentifier": "f5a3fcff-db1d-4b7c-9fa0-0349e41c29c5",
"hourlyBillingFlag": true,
"memoryCapacity": 2,
"operatingSystemReferenceCode": "UBUNTU_LATEST",
"processorCoreAmount": 2
}
-
getObjectForSecurityModule750
@ApiMethod(value="getObject", instanceRequired=true) SecurityModule750 getObjectForSecurityModule750()
-