-
BluePages_Container_EmployeeProfile
-
BluePages_Search
Searches BluePages for an employee and returns a container representing the employee. Note that this service is not available to customers, despite being visible, and will return an error response.
-
BMS_Container_Country
-
IntegratedOfferingTeam_Container_Region
-
IntegratedOfferingTeam_Container_Region_Lead
-
IntegratedOfferingTeam_Region
This class represents an Integrated Offering Team region.
-
McAfee_Epolicy_Orchestrator_Version36_Agent_Details
The McAfee_Epolicy_Orchestrator_Version36_Agent_Details data type represents a virus scan agent and contains details about its version.
-
McAfee_Epolicy_Orchestrator_Version36_Agent_Parent_Details
The McAfee_Epolicy_Orchestrator_Version36_Agent_Parent_Details data type contains the name of an anti-virus policy.
-
McAfee_Epolicy_Orchestrator_Version36_Antivirus_Event
The McAfee_Epolicy_Orchestrator_Version36_Antivirus_Event data type represents a single anti-virus event. It contains details about the event such as the date the event occurred, the virus that is detected and the action that is taken.
-
McAfee_Epolicy_Orchestrator_Version36_Antivirus_Event_AccessProtection
The McAfee_Epolicy_Orchestrator_Version36_Antivirus_Event_AccessProtection data type represents an access protection event. It contains details about the event such as when it occurs, the process that caused it, and the rule that triggered the event.
-
McAfee_Epolicy_Orchestrator_Version36_Antivirus_Event_Filter_Description
The McAfee_Epolicy_Orchestrator_Version36_Antivirus_Event_Filter_Description data type contains the name of the rule that was triggered by an anti-virus event.
-
McAfee_Epolicy_Orchestrator_Version36_Hips_Version6_BlockedApplicationEvent
The McAfee_Epolicy_Orchestrator_Version36_Hips_Version6_BlockedApplicationEvent data type contains a single blocked application event. The details of the event are the time the event occurred, the process that generated the event and a brief description of the application that was blocked.
-
McAfee_Epolicy_Orchestrator_Version36_Hips_Version6_Event_Signature
The McAfee_Epolicy_Orchestrator_Version36_Hips_Version6_Event_Signature data type contains the signature name of a rule that generated an IPS event.
-
McAfee_Epolicy_Orchestrator_Version36_Hips_Version6_IPSEvent
The McAfee_Epolicy_Orchestrator_Version36_Hips_Version6_IPSEvent data type represents a single IPS event. It contains details about the event such as the date the event occurred, the process that generated it, the severity of the event, and the action taken.
-
McAfee_Epolicy_Orchestrator_Version36_Hips_Version7_BlockedApplicationEvent
The McAfee_Epolicy_Orchestrator_Version36_Hips_Version7_BlockedApplicationEvent data type contains a single blocked application event. The details of the event are the time the event occurred, the process that generated the event and a brief description of the application that was blocked.
-
McAfee_Epolicy_Orchestrator_Version36_Hips_Version7_Event_Signature
The McAfee_Epolicy_Orchestrator_Version36_Hips_Version7_Event_Signature data type contains the signature name of a rule that generated an IPS event.
-
McAfee_Epolicy_Orchestrator_Version36_Hips_Version7_IPSEvent
The McAfee_Epolicy_Orchestrator_Version36_Hips_Version7_IPSEvent data type represents a single IPS event. It contains details about the event such as the date the event occurred, the process that generated it, the severity of the event, and the action taken.
-
McAfee_Epolicy_Orchestrator_Version36_Policy_Object
The McAfee_Epolicy_Orchestrator_Version36_Policy_Object data type contains the name of a policy that may be assigned to a server.
-
McAfee_Epolicy_Orchestrator_Version36_Product_Properties
The McAfee_Epolicy_Orchestrator_Version36_Product_Properties data type contains the virus definition file version.
-
McAfee_Epolicy_Orchestrator_Version45_Agent_Details
The McAfee_Epolicy_Orchestrator_Version45_Agent_Details data type represents a virus scan agent and contains details about its version.
-
McAfee_Epolicy_Orchestrator_Version45_Agent_Parent_Details
The McAfee_Epolicy_Orchestrator_Version45_Agent_Parent_Details data type contains the name of an anti-virus policy.
-
McAfee_Epolicy_Orchestrator_Version45_Event
The McAfee_Epolicy_Orchestrator_Version45_Event data type represents a single event. It contains details about the event such as the date the event occurred, the virus or intrusion that is detected and the action that is taken.
-
McAfee_Epolicy_Orchestrator_Version45_Event_Filter_Description
The McAfee_Epolicy_Orchestrator_Version45_Event_Filter_Description data type contains the name of the rule that was triggered by an event.
-
McAfee_Epolicy_Orchestrator_Version45_Event_Version7
The McAfee_Epolicy_Orchestrator_Version45_Event_Version7 data type represents a single event. It contains details about the event such as the date the event occurred, the virus or intrusion that is detected and the action that is taken.
-
McAfee_Epolicy_Orchestrator_Version45_Event_Version8
The McAfee_Epolicy_Orchestrator_Version45_Event_Version8 data type represents a single event. It contains details about the event such as the date the event occurred, the virus or intrusion that is detected and the action that is taken.
-
McAfee_Epolicy_Orchestrator_Version45_Hips_Event_Signature_Version7
The McAfee_Epolicy_Orchestrator_Version45_Hips_Event_Signature_Version7 data type contains the signature name of a rule that generated an IPS event.
-
McAfee_Epolicy_Orchestrator_Version45_Hips_Event_Signature_Version8
The McAfee_Epolicy_Orchestrator_Version45_Hips_Event_Signature_Version8 data type contains the signature name of a rule that generated an IPS event.
-
McAfee_Epolicy_Orchestrator_Version45_Policy_Object
The McAfee_Epolicy_Orchestrator_Version45_Policy_Object data type contains the name of a policy that may be assigned to a server.
-
McAfee_Epolicy_Orchestrator_Version45_Product_Properties
The McAfee_Epolicy_Orchestrator_Version45_Product_Properties data type contains the virus definition file version.
-
McAfee_Epolicy_Orchestrator_Version51_Agent_Details
The McAfee_Epolicy_Orchestrator_Version51_Agent_Details data type represents a virus scan agent and contains details about its version.
-
McAfee_Epolicy_Orchestrator_Version51_Policy_Object
The McAfee_Epolicy_Orchestrator_Version51_Policy_Object data type represents a virus scan agent and contains details about its version.
-
McAfee_Epolicy_Orchestrator_Version51_Product_Properties
The McAfee_Epolicy_Orchestrator_Version51_Product_Properties data type represents the version of the virus data file
-
SoftLayer_Abuse_Lockdown_Resource
-
SoftLayer_Account
The SoftLayer_Account data type contains general information relating to a single SoftLayer customer account. Personal information in this type such as names, addresses, and phone numbers are assigned to the account only and not to users belonging to the account. The SoftLayer_Account data type contains a number of relational properties that are used by the SoftLayer customer portal to quickly present a variety of account related services to it's users.
SoftLayer customers are unable to change their company account information in the portal or the API. If you need to change this information please open a sales ticket in our customer portal and our account management staff will assist you.
-
SoftLayer_Account_AbuseEmail
An unfortunate facet of the hosting business is the necessity of with legal and network abuse inquiries. As these types of inquiries frequently contain sensitive information SoftLayer keeps a separate account contact email address for direct contact about legal and abuse matters, modeled by the SoftLayer_Account_AbuseEmail data type. SoftLayer will typically email an account's abuse email addresses in these types of cases, and an email is automatically sent to an account's abuse email addresses when a legal or abuse ticket is created or updated.
-
SoftLayer_Account_Address
The SoftLayer_Account_Address data type contains information on an address associated with a SoftLayer account.
-
SoftLayer_Account_Address_Type
-
SoftLayer_Account_Affiliation
This service allows for a unique identifier to be associated to an existing customer account.
-
SoftLayer_Account_Agreement
-
SoftLayer_Account_Agreement_Status
-
SoftLayer_Account_Agreement_Type
-
SoftLayer_Account_Attachment_Employee
A SoftLayer_Account_Attachment_Employee models an assignment of a single [SoftLayer_User_Employee](/reference/datatypes/SoftLayer_User_Employee) with a single [SoftLayer_Account](/reference/datatypes/SoftLayer_Account)
-
SoftLayer_Account_Attachment_Employee_Role
-
SoftLayer_Account_Attribute
Many SoftLayer customer accounts have individual attributes assigned to them that describe features or special features for that account, such as special pricing, account statuses, and ordering instructions. The SoftLayer_Account_Attribute data type contains information relating to a single SoftLayer_Account attribute.
-
SoftLayer_Account_Attribute_Type
SoftLayer_Account_Attribute_Type models the type of attribute that can be assigned to a SoftLayer customer account.
-
SoftLayer_Account_Authentication_Attribute
Account authentication has many different settings that can be set. This class allows the customer or employee to set these settings.
-
SoftLayer_Account_Authentication_Attribute_Type
SoftLayer_Account_Authentication_Attribute_Type models the type of attribute that can be assigned to a SoftLayer customer account authentication.
-
SoftLayer_Account_Authentication_OpenIdConnect_Option
-
SoftLayer_Account_Authentication_OpenIdConnect_RegistrationInformation
-
SoftLayer_Account_Authentication_Saml
-
SoftLayer_Account_Brand_Migration_Request
Represents a request to migrate an account to the owned brand.
-
SoftLayer_Account_Business_Partner
Contains business partner details associated with an account. Country Enterprise Identifier (CEID), Channel ID, Segment ID and Reseller Level.
-
SoftLayer_Account_Classification_Group_Type
-
SoftLayer_Account_Contact
-
SoftLayer_Account_Contact_Type
-
SoftLayer_Account_External_Setup
This service class allows the user to set up an account to be billed by an external billing system.
-
SoftLayer_Account_Historical_Report
SoftLayer's account historical report service allows users to access a broad overview of devices for that account and historical details concerning the overall function and performance of the devices on that account
-
SoftLayer_Account_Internal_Ibm
Processes requests by IBM employees to create an IaaS account tied to their email. Request process cannot be initiated directly and must go through the Bluemix IBMer account request form.
-
SoftLayer_Account_Internal_Ibm_CostRecovery_Validator
Allows eligible utility users to verify internal cost recovery information.
-
SoftLayer_Account_Link
-
SoftLayer_Account_Link_Bluemix
-
SoftLayer_Account_Link_Vendor
-
SoftLayer_Account_Lockdown_Request
The SoftLayer_Account_Lockdown_Request data type holds information on API requests from brand customers.
-
SoftLayer_Account_MasterServiceAgreement
-
SoftLayer_Account_Media
The SoftLayer_Account_Media data type contains information on a single piece of media associated with a Data Transfer Service request.
-
SoftLayer_Account_Media_Data_Transfer_Request
The SoftLayer_Account_Media_Data_Transfer_Request data type contains information on a single Data Transfer Service request. Creation of these requests is limited to SoftLayer customers through the SoftLayer Customer Portal.
-
SoftLayer_Account_Media_Data_Transfer_Request_Status
The SoftLayer_Account_Media_Data_Transfer_Request_Status data type contains general information relating to the statuses to which a Data Transfer Request may be set.
-
SoftLayer_Account_Media_Type
The SoftLayer_Account_Media_Type data type contains general information relating to the different types of media devices that SoftLayer currently supports, as part of the Data Transfer Request Service. Such devices as USB hard drives and flash drives, as well as optical media such as CD and DVD are currently supported.
-
SoftLayer_Account_Network_Vlan_Span
The SoftLayer_Account_Network_Vlan_Span data type exposes the setting which controls the automatic spanning of private VLANs attached to a given customers account.
-
SoftLayer_Account_Note
-
SoftLayer_Account_Note_History
-
SoftLayer_Account_Partner_Referral_Prospect
-
SoftLayer_Account_Password
The SoftLayer_Account_Password contains username, passwords and notes for services that may require for external applications such the Webcc interface for the EVault Storage service.
-
SoftLayer_Account_Password_Type
Every username and password combination associated with a SoftLayer customer account belongs to a service that SoftLayer provides. The relationship between a username/password and it's service is provided by the SoftLayer_Account_Password_Type data type. Each username/password belongs to a single service type.
-
SoftLayer_Account_ProofOfConcept
Approved IBM sales representatives can use this service to request and manage temporary access on behalf of clients. This access is subject to multiple layers of approval and requires payment arrangement in advance.
This service is unavailable to users outside of IBM and is not applicable to the majority of users.
-
SoftLayer_Account_ProofOfConcept_Approver
This class represents a Proof of Concept account approver.
-
SoftLayer_Account_ProofOfConcept_Approver_Role
This class represents a Proof of Concept account approver type. The current roles are Primary and Backup approvers.
-
SoftLayer_Account_ProofOfConcept_Approver_Type
This class represents a Proof of Concept account approver type.
-
SoftLayer_Account_ProofOfConcept_Campaign_Code
A [SoftLayer_Account_ProofOfConcept_Campaign_Code] provides a `code` and an optional `description`.
-
SoftLayer_Account_ProofOfConcept_Funding_Type
-
SoftLayer_Account_Regional_Registry_Detail
The subnet registration detail type has been deprecated.
-
SoftLayer_Account_Regional_Registry_Detail_Property
The subnet registration detail property type has been deprecated.
Subnet registration properties are used to define various attributes of the [SoftLayer_Account_Regional_Registry_Detail](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail). These properties are defined by the [SoftLayer_Account_Regional_Registry_Detail_Property_Type](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail_Property_Type) objects, which describe the available value formats.
-
SoftLayer_Account_Regional_Registry_Detail_Property_Type
The subnet registration detail property type type has been deprecated.
Subnet Registration Detail Property Type objects describe the nature of a [SoftLayer_Account_Regional_Registry_Detail_Property](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail_Property) object. These types use [http://php.net/pcre.pattern.php Perl-Compatible Regular Expressions] to validate the value of a property object.
-
SoftLayer_Account_Regional_Registry_Detail_Type
The subnet registration detail type type has been deprecated.
Subnet Registration Detail Type objects describe the nature of a [SoftLayer_Account_Regional_Registry_Detail](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail) object.
The standard values for these objects are as follows: <ul> <li><strong>NETWORK</strong> - The detail object represents the information for a [SoftLayer_Network_Subnet](/reference/datatypes/SoftLayer_Network_Subnet)</li> <li><strong>NETWORK6</strong> - The detail object represents the information for an [SoftLayer_Network_Subnet_Version6](/reference/datatypes/SoftLayer_Network_Subnet_Version6)</li> <li><strong>PERSON</strong> - The detail object represents the information for a customer with the RIR</li> </ul>
-
SoftLayer_Account_Regional_Registry_Detail_Version4_Person_Default
The subnet registration default person detail type has been deprecated.
The SoftLayer_Account_Regional_Registry_Detail_Version4_Person_Default data type contains general information relating to a single SoftLayer RIR account. RIR account information in this type such as names, addresses, and phone numbers are assigned to the registry only and not to users belonging to the account.
-
SoftLayer_Account_Reports_Request
-
SoftLayer_Account_Rwhois_Handle
The subnet registration handle type has been deprecated.
Provides a means of tracking handle identifiers at the various regional internet registries (RIRs). These objects are used by the [SoftLayer_Network_Subnet_Registration](/reference/datatypes/SoftLayer_Network_Subnet_Registration) objects to identify a customer or organization when a subnet is registered.
-
SoftLayer_Account_Shipment
The SoftLayer_Account_Shipment data type contains information relating to a shipment. Basic information such as addresses, the shipment courier, and any tracking information for as shipment is accessible with this data type.
-
SoftLayer_Account_Shipment_Item
The SoftLayer_Account_Shipment_Item data type contains information relating to a shipment's item. Basic information such as addresses, the shipment courier, and any tracking information for as shipment is accessible with this data type.
-
SoftLayer_Account_Shipment_Item_Type
-
SoftLayer_Account_Shipment_Resource_Type
-
SoftLayer_Account_Shipment_Status
-
SoftLayer_Account_Shipment_Tracking_Data
The SoftLayer_Account_Shipment_Tracking_Data data type contains information on a single piece of tracking information pertaining to a shipment. This tracking information tracking numbers by which the shipment may be tracked through the shipping courier.
-
SoftLayer_Account_Shipment_Type
-
SoftLayer_Account_Status
-
SoftLayer_Account_Status_Change_Reason
Represents a reason for changing the account status.
-
SoftLayer_Auxiliary_Network_Status
-
SoftLayer_Auxiliary_Notification_Emergency
A SoftLayer_Auxiliary_Notification_Emergency data object represents a notification event being broadcast to the SoftLayer customer base. It is used to provide information regarding outages or current known issues.
-
SoftLayer_Auxiliary_Notification_Emergency_Signature
Every SoftLayer_Auxiliary_Notification_Emergency has a signatureId that references a SoftLayer_Auxiliary_Notification_Emergency_Signature data type. The signature is the user or group responsible for the current event.
-
SoftLayer_Auxiliary_Notification_Emergency_Status
Every SoftLayer_Auxiliary_Notification_Emergency has a statusId that references a SoftLayer_Auxiliary_Notification_Emergency_Status data type. The status is used to determine the current state of the event.
-
SoftLayer_Auxiliary_Shipping_Courier
The SoftLayer_Auxiliary_Shipping_Courier data type contains general information relating the different (major) couriers that SoftLayer may use for shipping.
-
SoftLayer_Auxiliary_Shipping_Courier_Type
-
SoftLayer_Billing_Chargeback_Type
-
SoftLayer_Billing_Currency
-
SoftLayer_Billing_Currency_Country
The SoftLayer_Billing_Currency_Country data type maps what currencies are valid for specific countries. US Dollars are valid from any country, but other currencies are only available to customers in certain countries.
-
SoftLayer_Billing_Currency_ExchangeRate
-
SoftLayer_Billing_Info
Every SoftLayer customer account has billing specific information which is kept in the SoftLayer_Billing_Info data type. This information is used by the SoftLayer accounting group when sending invoices and making billing inquiries.
-
SoftLayer_Billing_Info_Ach
-
SoftLayer_Billing_Info_Cycle
The SoftLayer_Billing_Info_Cycle data type models basic information concerning a SoftLayer account's previous and current billing cycles. The information in this class is only populated for SoftLayer customers who are billed monthly.
-
SoftLayer_Billing_Invoice
The SoftLayer_Billing_Invoice data type contains general information relating to an individual invoice applied to a SoftLayer customer account. Personal information in this type such as names, addresses, and phone numbers are taken from the account's contact information at the time the invoice is generated.
-
SoftLayer_Billing_Invoice_Item
Each billing invoice item makes up a record within an invoice. This provides you with a detailed record of everything related to an invoice item. When you are billed, our system takes active billing items and creates an invoice. These invoice items are a copy of your active billing items, and make up the contents of your invoice.
-
SoftLayer_Billing_Invoice_Item_Hardware
The SoftLayer_Billing_Invoice_Item_Hardware data type contains a 'resource'. This resource is a link to the hardware tied to a SoftLayer_Billing_item whose category code is 'server'.
-
SoftLayer_Billing_Invoice_Item_Tax_Info
Information about the tax rates that apply to a particular invoice item.
-
SoftLayer_Billing_Invoice_Next
Service for an account's next invoice. The 'next invoice' is what a customer will be billed on their next invoice, assuming no changes are made. Currently this does not include Bandwidth Pooling charges. Note, this should be considered preliminary as you may add, remove, or change billing items on your account.
-
SoftLayer_Billing_Invoice_Receivable_Payment
The SoftLayer_Billing_Invoice_Receivable_Payment data type contains general information relating to payments made against invoices.
-
SoftLayer_Billing_Invoice_Tax_Info
Invoice tax information contains top-level information about the taxes recorded for a particular invoice.
-
SoftLayer_Billing_Invoice_Tax_Status
The invoice tax status data type models a single status or state that an invoice can reflect in regard to an integration with a third-party tax calculation service.
-
SoftLayer_Billing_Invoice_Tax_Type
The invoice tax type data type models a single strategy for handling tax calculations.
-
SoftLayer_Billing_Item
Every individual item that a SoftLayer customer is billed for is recorded in the SoftLayer_Billing_Item data type. Billing items range from server chassis to hard drives to control panels, bandwidth quota upgrades and port upgrade charges. Softlayer [SoftLayer_Billing_Invoice](/reference/datatypes/SoftLayer_Billing_Invoice) are generated from the cost of a customer's billing items. Billing items are copied from the product catalog as they're ordered by customers to create a reference between an account and the billable items they own.
Billing items exist in a tree relationship. Items are associated with each other by parent/child relationships. Component items such as CPU's, RAM, and software each have a parent billing item for the server chassis they're associated with. Billing Items with a null parent item do not have an associated parent item.
-
SoftLayer_Billing_Item_Account_Media_Data_Transfer_Request
The SoftLayer_Billing_Item_Account_Media_Data_Transfer_Request data type contains general information relating to a single SoftLayer billing item for a data transfer request.
-
SoftLayer_Billing_Item_Association_History
The SoftLayer_Billing_Item_Association_History type keeps a record of which server billing items an 'orphan' item has been associated with. Orphan billing items are billable items for secondary portable services (such as secondary subnets and StorageLayer accounts) that are not associated with a server and appear at the bottom of a SoftLayer invoice. The [SoftLayer_Billing_Item::setAssociationId](/reference/datatypes/$1/#$2) method allows you to associate these kinds of items with servers, making them appear as a child item of the server on your invoice. A SoftLayer_Billing_Item_Association_History record is created every time one of these associations are set.
-
SoftLayer_Billing_Item_Cancellation_Reason
The SoftLayer_Billing_Item_Cancellation_Reason data type contains cancellation reasons.
-
SoftLayer_Billing_Item_Cancellation_Reason_Category
The SoftLayer_Billing_Item_Cancellation_Reason_Category data type contains cancellation reason categories.
-
SoftLayer_Billing_Item_Cancellation_Request
SoftLayer_Billing_Item_Cancellation_Request data type is used to cancel service billing items.
-
SoftLayer_Billing_Item_Cancellation_Request_Item
SoftLayer_Billing_Item_Cancellation_Request_Item data type contains a billing item for cancellation. This data type is used to harness billing items to the associated service.
-
SoftLayer_Billing_Item_Cancellation_Request_Status
SoftLayer_Billing_Item_Cancellation_Request_Status data type represents the status of a service cancellation request.
-
SoftLayer_Billing_Item_Chronicle
-
SoftLayer_Billing_Item_Ctc_Account
The SoftLayer_Billing_Item_Ctc_Account data type contains general information relating to a single SoftLayer billing item for a CTC client account creation
-
SoftLayer_Billing_Item_Gateway_Appliance_Cluster
The SoftLayer_Billing_Item_Big_Data_Cluster data type contains general information relating to a single SoftLayer billing item for a big data cluster.
-
SoftLayer_Billing_Item_Gateway_License
The SoftLayer_Billing_Item_Gateway_License data type contains general information relating to a single SoftLayer billing item for a bare_metal_gateway_license
-
SoftLayer_Billing_Item_Hardware
The SoftLayer_Billing_Item_Hardware data type contains general information relating to a single SoftLayer billing item for hardware.
-
SoftLayer_Billing_Item_Hardware_Colocation
The SoftLayer_Billing_Item_Hardware data type contains general information relating to a single SoftLayer billing item for hardware.
-
SoftLayer_Billing_Item_Hardware_Component
The SoftLayer_Billing_Item_Hardware data type contains general information relating to a single SoftLayer billing item for hardware components.
-
SoftLayer_Billing_Item_Hardware_Security_Module
The SoftLayer_Billing_Item_Hardware_Security_Module data type contains general information relating to a single SoftLayer billing item for a hardware security module.
-
SoftLayer_Billing_Item_Hardware_Server
The SoftLayer_Billing_Item_Hardware_Server data type contains billing information about a bare metal server and its relationship to a particular customer account.
-
SoftLayer_Billing_Item_Network_Application_Delivery_Controller
The SoftLayer_Billing_Item_Network_Application_Delivery_Controller data type describes the billing item related to a NetScaler VPX
-
SoftLayer_Billing_Item_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress
A SoftLayer_Billing_Item_Network_Application_Delivery_Controller_LoadBalancer represents the [SoftLayer_Billing_Item](/reference/datatypes/SoftLayer_Billing_Item) related to a single [SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress](/reference/datatypes/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress) instance.
-
SoftLayer_Billing_Item_Network_Bandwidth
The SoftLayer_Billing_Item_Hardware data type contains general information relating to a single SoftLayer billing item for hardware.
-
SoftLayer_Billing_Item_Network_Firewall
The SoftLayer_Billing_Item_Network_Firewall data type contains general information relating to a single SoftLayer billing item whose item category code is 'firewall'
-
SoftLayer_Billing_Item_Network_Firewall_Module_Context
The SoftLayer_Billing_Item_Network_Firewall_Module_Context data type describes the billing items related to VLAN Firewalls.
-
SoftLayer_Billing_Item_Network_Interconnect
A SoftLayer_Billing_Item_Network_Interconnect represents the [SoftLayer_Billing_Item](/reference/datatypes/SoftLayer_Billing_Item) related to a network interconnect instance.
-
SoftLayer_Billing_Item_Network_Interconnect_Routing
A SoftLayer_Billing_Item_Network_Interconnect_Routing represents the [SoftLayer_Billing_Item](/reference/datatypes/SoftLayer_Billing_Item) related to a network interconnect global routing.
-
SoftLayer_Billing_Item_Network_LoadBalancer
A SoftLayer_Billing_Item_Network_LoadBalancer represents the [SoftLayer_Billing_Item](/reference/datatypes/SoftLayer_Billing_Item) related to a single [SoftLayer_Network_LoadBalancer](/reference/datatypes/SoftLayer_Network_LoadBalancer) instance.
-
SoftLayer_Billing_Item_Network_LoadBalancer_VirtualIpAddress
A SoftLayer_Billing_Item_Network_LoadBalancer_VirtualIpAddress represents the [SoftLayer_Billing_Item](/reference/datatypes/SoftLayer_Billing_Item) related to a single [SoftLayer_Network_LoadBalancer_VirtualIpAddress](/reference/datatypes/SoftLayer_Network_LoadBalancer_VirtualIpAddress) instance.
-
SoftLayer_Billing_Item_Network_Message_Delivery
The SoftLayer_Billing_Item_Network_Message_Delivery data describes the related billing item.
-
SoftLayer_Billing_Item_Network_PerformanceStorage_Iscsi
The SoftLayer_Billing_Item_Network_PerformanceStorage_Iscsi data type contains general information relating to a single SoftLayer billing item whose item category code is 'performance_storage_iscsi'
-
SoftLayer_Billing_Item_Network_PerformanceStorage_Nfs
The SoftLayer_Billing_Item_Network_PerformanceStorage_Nfs data type contains general information relating to a single SoftLayer billing item whose item category code is 'performance_storage_nfs'
-
SoftLayer_Billing_Item_Network_Storage
The SoftLayer_Billing_Item_Network_Storage data type describes the billing items related to StorageLayer accounts.
-
SoftLayer_Billing_Item_Network_Storage_Hub
The SoftLayer_Billing_Item_Network_Storage_Hub models all billing items related to hub-based StorageLayer offerings, such as CloudLayer storage.
-
SoftLayer_Billing_Item_Network_Storage_Hub_Bandwidth
The SoftLayer_Billing_Item_Network_Storage_Hub_Bandwidth data type models the billing items created when a CloudLayer storage account generates a bandwidth overage charge.
-
SoftLayer_Billing_Item_Network_Subnet
The SoftLayer_Billing_Item_Network_Subnet data type contains general information relating to a single SoftLayer billing item whose item category code is one of the following: * pri_ip_address * static_sec_ip_addresses (static secondary) * sov_sec_ip_addresses (secondary on vlan, also known as 'portable ips') * sov_sec_ip_addresses_pub (sov_sec_ip_addresses public only) * sov_sec_ip_addresses_priv (sov_sec_ip_addresses private only) * sec_ip_addresses (old style, secondary ip addresses)
These item categories denote that the billing item has subnet information attached.
-
SoftLayer_Billing_Item_Network_Subnet_IpAddress_Global
The SoftLayer_Billing_Item_Network_Subnet_IpAddress_Global data type contains general information relating to a single SoftLayer billing item whose item category code is one of the following: * global_ipv4 * global_ipv6
These item categories denote that the billing item has subnet information attached.
-
SoftLayer_Billing_Item_Network_Tunnel
The SoftLayer_Billing_Item_Network_Storage data type describes the billing items related to StorageLayer accounts.
-
SoftLayer_Billing_Item_Network_Vlan
The SoftLayer_Billing_Item_Network_Vlan data type contains general information relating to a single SoftLayer billing item whose item category code is one of the following: * network_vlan
These item categories denote that the billing item has network vlan information attached.
-
SoftLayer_Billing_Item_NewCustomerSetup
-
SoftLayer_Billing_Item_Private_Cloud
The SoftLayer_Billing_Item_Private_Cloud data type contains general information relating to a single billing item for a private cloud.
-
SoftLayer_Billing_Item_Software_Component
The SoftLayer_Billing_Item_Hardware data type contains general information relating to a single SoftLayer billing item for hardware components.
-
SoftLayer_Billing_Item_Software_Component_Analytics_Urchin
The SoftLayer_Billing_Item_Software_Component_Analytics_Urchin data type contains general information relating to a single SoftLayer billing item for Urchin software components.
-
SoftLayer_Billing_Item_Software_Component_ControlPanel
The SoftLayer_Billing_Item_Software_Component_ControlPanel data type contains general information relating to a single SoftLayer billing item for control panel software components.
-
SoftLayer_Billing_Item_Software_Component_ControlPanel_Parallels_Plesk_Billing
The SoftLayer_Billing_Item_Software_Component_ControlPanel data type contains general information relating to a single SoftLayer billing item for control panel software components.
-
SoftLayer_Billing_Item_Software_Component_OperatingSystem_Addon
The SoftLayer_Billing_Item_Software_Component_OperatingSystem_Addon data type contains general information relating to a single SoftLayer billing item for operating system add-on software components.
-
SoftLayer_Billing_Item_Software_Component_OperatingSystem_Addon_Citrix_Essentials
The SoftLayer_Billing_Item_Software_Component_OperatingSystem_Addon_Citrix_Essentials data type contains general information relating to a single SoftLayer billing item for Citrix Essentials software components.
-
SoftLayer_Billing_Item_Software_Component_Virtual_OperatingSystem
The SoftLayer_Billing_Item_Software_Component_Virtual_OperatingSystem data type contains general information relating to a single SoftLayer billing item for operating system software components on virtual machines.
-
SoftLayer_Billing_Item_Software_Component_Virtual_OperatingSystem_Microsoft
The SoftLayer_Billing_Item_Software_Component_Virtual_OperatingSystem_Microsoft data type contains general information relating to a single SoftLayer billing item for a Microsoft operating system software components on virtual machines.
-
SoftLayer_Billing_Item_Software_Component_Virtual_OperatingSystem_Redhat
The SoftLayer_Billing_Item_Software_Component_Virtual_OperatingSystem_Microsoft data type contains general information relating to a single SoftLayer billing item for a Microsoft operating system software components on virtual machines.
-
SoftLayer_Billing_Item_Software_License
The SoftLayer_Billing_Item_Software_License data type contains general information relating to a single SoftLayer billing item for a software license.
-
SoftLayer_Billing_Item_Support
The SoftLayer_Billing_Item_Support data type contains general information relating to a premium support offering
-
SoftLayer_Billing_Item_User_Customer_External_Binding
The SoftLayer_Billing_Item_Network_Application_Delivery_Controller data type describes the billing item related to an external authentication binding
-
SoftLayer_Billing_Item_Virtual_Dedicated_Rack
A SoftLayer_Billing_Item_Virtual_Dedicated_Rack data type models the billing information for a single bandwidth pooling. Bandwidth pooling members share their public bandwidth allocations, and incur overage charges instead of the overages on individual rack members. Virtual rack billing items are the parent items for all of it's rack membership billing items.
-
SoftLayer_Billing_Item_Virtual_DedicatedHost
-
SoftLayer_Billing_Item_Virtual_Disk_Image
The SoftLayer_Billing_Item_Virtual_Disk_Image data type contains general information relating to a single SoftLayer billing item for disk images.
-
SoftLayer_Billing_Item_Virtual_Guest
The SoftLayer_Billing_Item_Virtual_Guest data type contains general information relating to a single SoftLayer billing item for guests.
-
SoftLayer_Billing_Item_Virtual_Host_Usage
The SoftLayer_Billing_Item_Virtual_Host_Usage data type contains general information relating to a single SoftLayer billing item for virtual machine peak usage
-
SoftLayer_Billing_Item_Virtual_ReservedCapacity
-
SoftLayer_Billing_Item_Workspace
The SoftLayer_Billing_Item_Workspace data type contains general information relating to a single SoftLayer billing item whose item category code is 'workspace'
-
SoftLayer_Billing_Order
The SoftLayer_Billing_Order data type contains general information relating to an individual order applied to a SoftLayer customer account or to a new customer. Personal information in this type such as names, addresses, and phone numbers are taken from the account's contact information at the time the order is generated for existing SoftLayer customer.
-
SoftLayer_Billing_Order_Cart
The [SoftLayer_Billing_Order_Cart](/reference/datatypes/SoftLayer_Billing_Order_Cart) service allows customers to save their order in a state that can be continually modified. The difference between a cart and a quote is that a quote has locked-in prices while a cart does not. This allows customers to save their order configuration for up to 30 days. After 30 days, the cart is deleted and cannot be retrieved again.
-
SoftLayer_Billing_Order_Item
Every individual item that a SoftLayer customer is billed for is recorded in the SoftLayer_Billing_Item data type. Billing items range from server chassis to hard drives to control panels, bandwidth quota upgrades and port upgrade charges. SoftLayer [SoftLayer_Billing_Invoice](/reference/datatypes/SoftLayer_Billing_Invoice) are generated from the cost of a customer's billing items. Billing items are copied from the product catalog as they're ordered by customers to create a reference between an account and the billable items they own.
Billing items exist in a tree relationship. Items are associated with each other by parent/child relationships. Component items such as CPU's, RAM, and software each have a parent billing item for the server chassis they're associated with. Billing Items with a null parent item do not have an associated parent item.
-
SoftLayer_Billing_Order_Item_Category_Answer
The SoftLayer_Billing_Order_Item_Category_Answer data type represents a single answer to an item category question.
-
SoftLayer_Billing_Order_Quote
The SoftLayer_Billing_Oder_Quote data type contains general information relating to an individual order applied to a SoftLayer customer account or to a new customer. Personal information in this type such as names, addresses, and phone numbers are taken from the account's contact information at the time the quote is generated for existing SoftLayer customer.
-
SoftLayer_Billing_Order_Type
The SoftLayer_Billing_Oder_Type data type contains general information relating to all the different types of orders that exist. This data pertains only to where an order was generated from, from any of the SoftLayer websites with ordering interfaces or directly through the SoftLayer API.
-
SoftLayer_Billing_Payment_Card_ChangeRequest
The SoftLayer_Billing_Payment_Card_ChangeRequest data type contains general information relating to attempted credit card information changes. This supports enablement of 3D Secure via Cardinal Cruise implementation that allows for credit card authentication and is currently limited to specified merchants.
-
SoftLayer_Billing_Payment_Card_ManualPayment
The SoftLayer_Billing_Payment_Card_ManualPayment data type contains general information related to requesting a manual payment. This supports enablement of 3D Secure via Cardinal Cruise implementation that allows for credit card authentication and is currently limited to specified merchants.
-
SoftLayer_Billing_Payment_Card_PayerAuthentication_Setup
This datatype payer authentication setup
-
SoftLayer_Billing_Payment_Card_PayerAuthentication_Setup_Information
This is the datatype that needs to be populated and sent to SoftLayer_Account::initiatePayerAuthentication.
-
SoftLayer_Billing_Payment_Card_Transaction
The SoftLayer_Billing_Payment_Card_Transaction data type contains general information relating to attempted credit card transactions.
-
SoftLayer_Billing_Payment_PayPal_Transaction
The SoftLayer_Billing_Payment_PayPal_Transaction data type contains general information relating to attempted PayPal transactions.
-
SoftLayer_Billing_Payment_Processor
-
SoftLayer_Billing_Payment_Processor_Method
-
SoftLayer_Billing_Payment_Processor_Type
-
SoftLayer_Billing_Payment_Transaction
Implementation for payment transactions.
-
SoftLayer_Billing_Payment_Type
-
SoftLayer_Brand
The SoftLayer_Brand data type contains brand information relating to the single SoftLayer customer account.
IBM Cloud Infrastructure customers are unable to change their brand information in the portal or the API.
-
SoftLayer_Brand_Attribute
-
SoftLayer_Brand_Business_Partner
Contains business partner details associated with a brand. Country Enterprise Identifier (CEID), Channel ID, Segment ID and Reseller Level.
-
SoftLayer_Brand_Contact
SoftLayer_Brand_Contact contains the contact information for the brand such as Corporate or Support contact information
-
SoftLayer_Brand_Contact_Type
SoftLayer_Brand_Contact_Type contains the contact type information for the brand contacts such as Corporate or Support contact type
-
SoftLayer_Brand_Payment_Processor
-
SoftLayer_Brand_Restriction_Location_CustomerCountry
The [SoftLayer_Brand_Restriction_Location_CustomerCountry](/reference/datatypes/SoftLayer_Brand_Restriction_Location_CustomerCountry) data type defines the relationship between brands, locations and countries associated with a user's account that are ineligible when ordering products. For example, the India datacenter may not be available on the SoftLayer US brand for customers that live in Great Britain.
-
SoftLayer_Business_Partner_Channel
Contains business partner channel information
-
SoftLayer_Business_Partner_Segment
Contains business partner segment information
-
SoftLayer_Catalyst_Affiliate
-
SoftLayer_Catalyst_Company_Type
-
SoftLayer_Catalyst_Enrollment
-
SoftLayer_Catalyst_Enrollment_Request
Contains user information for Catalyst self-enrollment.
-
SoftLayer_Catalyst_Enrollment_Request_Container_AnswerOption
-
SoftLayer_Compliance_Report_Type
-
SoftLayer_Configuration_Storage_Filesystem_Type
-
SoftLayer_Configuration_Storage_Group
This class describes the base Storage Group for a Complex Drive Configuration
-
SoftLayer_Configuration_Storage_Group_Array_Type
Supported hardware raid modes
-
SoftLayer_Configuration_Storage_Group_Order
Single storage group(array) used for a hardware server order.
If a raid configuration is required this object will describe a single array that will be configured on the server. If the server requires more than one array, a storage group will need to be created for each array.
-
SoftLayer_Configuration_Storage_Group_Template_Group
Single storage group(array) used in a storage group template.
If a server configuration requires a raid configuration this object will describe a single array to be configured.
-
SoftLayer_Configuration_Template
The SoftLayer_Configuration_Template data type contains general information of an arbitrary resource.
-
SoftLayer_Configuration_Template_Attribute
Configuration template attribute class contains supplementary information for a configuration template.
-
SoftLayer_Configuration_Template_Section
The SoftLayer_Configuration_Template_Section data type contains information of a configuration section.
Configuration can contain sub-sections.
-
SoftLayer_Configuration_Template_Section_Attribute
Configuration section attribute class contains supplementary information for a configuration section.
-
SoftLayer_Configuration_Template_Section_Definition
Configuration definition gives you details of the value that you're setting.
If value type is defined as 'Resource Specific Values', you will have to make an additional API call to retrieve your system specific values.
-
SoftLayer_Configuration_Template_Section_Definition_Attribute
Configuration definition attribute class contains supplementary information for a configuration definition.
-
SoftLayer_Configuration_Template_Section_Definition_Attribute_Type
SoftLayer_Configuration_Template_Attribute_Type models the type of attribute that can be assigned to a configuration definition.
-
SoftLayer_Configuration_Template_Section_Definition_Group
Configuration definition group gives you details of the definition and allows extra functionality.
-
SoftLayer_Configuration_Template_Section_Definition_Type
SoftLayer_Configuration_Template_Section_Definition_Type further defines the value of a configuration definition.
-
SoftLayer_Configuration_Template_Section_Definition_Value
SoftLayer_Configuration_Section_Value is used to set the value for a configuration definition
-
SoftLayer_Configuration_Template_Section_Profile
Some configuration templates let you create a unique configuration profiles.
For example, you can create multiple configuration profiles to monitor multiple hard drives with 'CPU/Memory/Disk Monitoring Agent'. SoftLayer_Configuration_Template_Section_Profile help you keep track of custom configuration profiles.
-
SoftLayer_Configuration_Template_Section_Reference
The SoftLayer_Configuration_Template_Section_Reference data type contains information of a configuration section and its associated configuration template.
-
SoftLayer_Configuration_Template_Section_Type
The SoftLayer_Configuration_Template_Section_Type data type contains information of a configuration section type.
Configuration can contain sub-sections.
-
SoftLayer_Configuration_Template_Type
The SoftLayer_Configuration_Template_Type data type contains configuration template type information.
-
SoftLayer_Container_Account_Authentication_OpenIdConnect_UsernameLookupContainer
-
SoftLayer_Container_Account_Discount_Program
SoftLayer_Container_Account_Discount_Program models a single outbound object for a graph of given data sets.
-
SoftLayer_Container_Account_Discount_Program_Collection
-
SoftLayer_Container_Account_External_Setup_ProvisioningHoldLifted
-
SoftLayer_Container_Account_External_Setup_ProvisioningHoldLifted_Attributes
-
SoftLayer_Container_Account_Historical_Summary
Historical Summary Container for account resource details
-
SoftLayer_Container_Account_Historical_Summary_Detail
Historical Summary Details Container for a resource's data
-
SoftLayer_Container_Account_Historical_Summary_Detail_Uptime
Historical Summary Details Container for a host resource uptime
-
SoftLayer_Container_Account_Historical_Summary_Uptime
Historical Summary Container for account host's resource uptime details
-
SoftLayer_Container_Account_Internal_Ibm_CostRecovery
-
SoftLayer_Container_Account_Internal_Ibm_Request
Contains data required to both request a new IaaS account for active IBM employees and review pending requests. Fields used exclusively in the review process are scrubbed of user input.
-
SoftLayer_Container_Account_Payment_Method_CreditCard
-
SoftLayer_Container_Account_PersonalInformation
-
SoftLayer_Container_Account_ProofOfConcept_Contact_Customer
The customer and prospective owner of a proof of concept account established by an IBMer.
-
SoftLayer_Container_Account_ProofOfConcept_Contact_Ibmer_Requester
IBMer who is submitting a proof of concept request on behalf of a prospective customer.
-
SoftLayer_Container_Account_ProofOfConcept_Contact_Ibmer_Technical
IBMer who will assist the requester with technical aspects of configuring the proof of concept account.
-
SoftLayer_Container_Account_ProofOfConcept_Request_AccountFunded
Proof of concept request using the account team funding model. Note that proof of concept account request are available only to internal IBM employees.
-
SoftLayer_Container_Account_ProofOfConcept_Request_CostRecovery
Funding codes for the department paying for the proof of concept account.
-
SoftLayer_Container_Account_ProofOfConcept_Request_GlobalFunded
Proof of concept request using the global funding model. Note that proof of concept account request are available only to internal IBM employees.
-
SoftLayer_Container_Account_ProofOfConcept_Request_Opportunity
Internal IBM opportunity codes required when applying for a Proof of Concept account.
-
SoftLayer_Container_Account_ProofOfConcept_Review
Full details presented to reviewers when determining whether or not to accept a proof of concept request. Note that reviewers are internal IBM employees and reviews are not exposed to external users.
-
SoftLayer_Container_Account_ProofOfConcept_Review_Event
Review event within proof of concept request review period.
-
SoftLayer_Container_Account_ProofOfConcept_Review_History
Summary of review activity for a proof of concept request.
-
SoftLayer_Container_Account_ProofOfConcept_Review_Summary
Summary presented to reviewers when determining whether or not to accept a proof of concept request. Note that reviewers are internal IBM employees and reviews are not exposed to external users.
-
SoftLayer_Container_Account_Update_Response
Contains data related to an account after editing its information.
-
SoftLayer_Container_Authentication_Request_Common
The SoftLayer_Container_Authentication_Request_Common data type contains common information for requests to the getPortalLogin API. This is an abstract class that serves as a base that more specialized classes will derive from. For example, a request class specific to SoftLayer Native IMS Login (username and password).
-
SoftLayer_Container_Authentication_Request_Contract
The SoftLayer_Container_Authentication_Request_Contract provides a common set of operations for implementing classes.
-
SoftLayer_Container_Authentication_Request_Native
The SoftLayer_Container_Authentication_Request_Native data type contains information for requests to the getPortalLogin API. This class is specific to the SoftLayer Native login (username/password). The request information will be verified to ensure it is valid, and then there will be an attempt to obtain a portal login token in authenticating the user with the provided information.
-
SoftLayer_Container_Authentication_Request_Native_External
The SoftLayer_Container_Authentication_Request_Native_External data type contains information for requests to the getPortalLogin API. This class serves as a base class for more specialized external authentication classes to the SoftLayer Native login (username/password).
-
SoftLayer_Container_Authentication_Request_Native_External_Totp
The SoftLayer_Container_Authentication_Request_Native_External_Totp data type contains information for requests to the getPortalLogin API. This class provides information to allow the user to submit a request to the native SoftLayer (username/password) login service for a portal login token, as well as submitting a request to the TOTP 2 factor authentication service.
-
SoftLayer_Container_Authentication_Request_Native_External_Verisign
The SoftLayer_Container_Authentication_Request_Native_External_Verisign data type contains information for requests to the getPortalLogin API. This class provides information to allow the user to submit a request to the native SoftLayer (username/password) login service for a portal login token, as well as submitting a request to the Verisign 2 factor authentication service.
-
SoftLayer_Container_Authentication_Request_OpenIdConnect
The SoftLayer_Container_Authentication_Request_OpenIdConnect data type contains information for requests to the getPortalLogin API. This class is specific to the SoftLayer Cloud Token login. The request information will be verified to ensure it is valid, and then there will be an attempt to obtain a portal login token in authenticating the user with the provided information.
-
SoftLayer_Container_Authentication_Request_OpenIdConnect_External
The SoftLayer_Container_Authentication_Request_OpenIdConnect_External data type contains information for requests to the getPortalLogin API. This class serves as a base class for more specialized external authentication classes to the SoftLayer OpenIdConnect login service.
-
SoftLayer_Container_Authentication_Request_OpenIdConnect_External_Totp
The SoftLayer_Container_Authentication_Request_OpenIdConnect_External_Totp data type contains information for requests to the getPortalLogin API. This class provides information to allow the user to submit a request to the SoftLayer OpenIdConnect (token) login service for a portal login token, as well as submitting a request to the TOTP 2 factor authentication service.
-
SoftLayer_Container_Authentication_Request_OpenIdConnect_External_Verisign
The SoftLayer_Container_Authentication_Request_OpenIdConnect_External_Verisign data type contains information for requests to the getPortalLogin API. This class provides information to allow the user to submit a request to the SoftLayer OpenIdConnect (token) login service for a portal login token, as well as submitting a request to the Verisign 2 factor authentication service.
-
SoftLayer_Container_Authentication_Response_2FactorAuthenticationNeeded
The SoftLayer_Container_Authentication_Response_2FactorAuthenticationNeeded data type contains information for specific responses from the getPortalLogin API. This class is indicative of a request that is missing the appropriate 2FA information.
-
SoftLayer_Container_Authentication_Response_Account
The SoftLayer_Container_Authentication_Response_Account data type contains account information for responses from the getPortalLogin API.
-
SoftLayer_Container_Authentication_Response_AccountIdMissing
The SoftLayer_Container_Authentication_Response_AccountIdMissing data type contains information for specific responses from the getPortalLogin API. This class is indicative of a request that is missing the account id.
-
SoftLayer_Container_Authentication_Response_Common
The SoftLayer_Container_Authentication_Response_Common data type contains common information for responses from the getPortalLogin API. This is an abstract class that serves as a base that more specialized classes will derive from. For example, a response class that is specific to a successful response from the getPortalLogin API.
-
SoftLayer_Container_Authentication_Response_IpAddressRestrictionCheckNeeded
The SoftLayer_Container_Authentication_Response_IpAddressRestrictionCheckNeeded data type indicates that the caller (IAM presumably) needs to do an IP address check of the logging-in user against the restricted IP list kept in BSS. We don't know the IP address of the user here (only IAM does) so we return an indicator of which user matched the username and expect IAM to come back with another login call that will include a mini-JWT token that contains an assertion that the IP address was checked.
-
SoftLayer_Container_Authentication_Response_LoginFailed
The SoftLayer_Container_Authentication_Response_LOGIN_FAILED data type contains information for specific responses from the getPortalLogin API. This class is indicative of a request where there was an inability to login based on the information that was provided.
-
SoftLayer_Container_Authentication_Response_Success
The SoftLayer_Container_Authentication_Response_SUCCESS data type contains information for specific responses from the getPortalLogin API. This class is indicative of a request that was successful in obtaining a portal login token from the getPortalLogin API.
-
SoftLayer_Container_Auxiliary_Network_Status_Reading
-
SoftLayer_Container_Bandwidth_GraphInputs
SoftLayer_Container_Bandwidth_GraphInputs models a single inbound object for a given bandwidth graph.
-
SoftLayer_Container_Bandwidth_GraphOutputs
SoftLayer_Container_Bandwidth_GraphOutputs models a single outbound object for a given bandwidth graph.
-
SoftLayer_Container_Bandwidth_Projection
SoftLayer_Container_Bandwidth_Projection models projected bandwidth use over a time range.
-
SoftLayer_Container_Bandwidth_Usage
When a customer uses SoftLayer_Account::getBandwidthUsage, this container is used to return their usage information in bytes
-
SoftLayer_Container_Billing_Currency_Country
-
SoftLayer_Container_Billing_Currency_Format
-
SoftLayer_Container_Billing_Info_Ach
-
SoftLayer_Container_Billing_Invoice_Email
This container is used to provide all the options for [SoftLayer_Billing_Invoice::emailInvoices](/reference/services/SoftLayer_Billing_Invoice/emailInvoices) in order to have the necessary invoices generated and links sent to the user's email.
-
SoftLayer_Container_Billing_Order_Status
SoftLayer_Container_Billing_Order_Status models an order status.
-
SoftLayer_Container_Catalyst_ManualEnrollmentRequest
Contains user information used to request a manual Catalyst enrollment.
-
SoftLayer_Container_Collection_Locale_CountryCode
This container is used to hold country locale information.
-
SoftLayer_Container_Collection_Locale_StateCode
This container is used to hold information regarding a state or province.
-
SoftLayer_Container_Collection_Locale_VatCountryCodeAndFormat
This container is used to hold VAT information.
-
SoftLayer_Container_Disk_Image_Capture_Template
-
SoftLayer_Container_Disk_Image_Capture_Template_Volume
-
SoftLayer_Container_Disk_Image_Capture_Template_Volume_Partition
-
SoftLayer_Container_Exception
The SoftLayer_Container_Exception data type represents a SoftLayer_Exception.
-
SoftLayer_Container_Graph
-
SoftLayer_Container_Graph_Option
-
SoftLayer_Container_Graph_Plot
-
SoftLayer_Container_Graph_Plot_Coordinate
-
SoftLayer_Container_Hardware_CaptureEnabled
-
SoftLayer_Container_Hardware_Configuration
The hardware configuration container is used to provide configuration options for servers.
Each configuration option will include both an <code>itemPrice</code> and a <code>template</code>.
The <code>itemPrice</code> value will provide hourly and monthly costs (if either are applicable), and a description of the option.
The <code>template</code> will provide a fragment of the request with the properties and values that must be sent when creating a server with the option.
The [SoftLayer_Hardware::getCreateObjectOptions](/reference/services/SoftLayer_Hardware/getCreateObjectOptions) method returns this data structure.
<style type='text/css'>#properties .views-field-body p { margin-top: 1.5em; };</style>
-
SoftLayer_Container_Hardware_Configuration_Option
An option found within a [SoftLayer_Container_Hardware_Configuration](/reference/datatypes/SoftLayer_Container_Hardware_Configuration) structure.
-
SoftLayer_Container_Hardware_DiskImageMap
-
SoftLayer_Container_Hardware_MassUpdate
-
SoftLayer_Container_Hardware_Pool_Details
-
SoftLayer_Container_Hardware_Pool_Details_Router
-
SoftLayer_Container_Hardware_Server_Configuration
The SoftLayer_Container_Hardware_Server_Configuration data type contains information relating to a server's item price information, and hard drive partition information.
-
SoftLayer_Container_Hardware_Server_Details
The SoftLayer_Container_Hardware_Server_Details data type contains information relating to a server's component information, network information, and software information.
-
SoftLayer_Container_Hardware_Server_Request
-
SoftLayer_Container_Image_StorageGroupDetails
-
SoftLayer_Container_Image_StorageGroupDetails_Drives
-
SoftLayer_Container_KnowledgeLayer_QuestionAnswer
SoftLayer_Container_KnowledgeLayer_QuestionAnswer models a single question and answer pair from SoftLayer's KnowledgeLayer knowledge base. SoftLayer's backend network interfaces with the KnowledgeLayer to recommend helpful articles when support tickets are created.
-
SoftLayer_Container_Message
-
SoftLayer_Container_Metric_Data_Type
-
SoftLayer_Container_Metric_Tracking_Object_Details
SoftLayer_Container_Metric_Tracking_Object_Details This container is a parent class for detailing diverse metrics.
-
SoftLayer_Container_Metric_Tracking_Object_Summary
SoftLayer_Container_Metric_Tracking_Object_Summary This container is a parent class for summarizing diverse metrics.
-
SoftLayer_Container_Metric_Tracking_Object_Virtual_Host_Details
SoftLayer_Container_Metric_Tracking_Object_Virtual_Host_Details This container details a virtual host's metric data.
-
SoftLayer_Container_Metric_Tracking_Object_Virtual_Host_Summary
SoftLayer_Container_Metric_Tracking_Object_Virtual_Host_Summary This container summarizes a virtual host's metric data.
-
SoftLayer_Container_Monitoring_Alarm_History
The SoftLayer_Container_Monitoring_Alarm_History data type contains information relating to SoftLayer monitoring alarm history.
-
SoftLayer_Container_Network_Authentication_Data
This object holds authentication data to a server.
-
SoftLayer_Container_Network_Bandwidth_Data_Summary
SoftLayer_Container_Network_Bandwidth_Data_Summary models an interface's overall bandwidth usage during it's current billing cycle.
-
SoftLayer_Container_Network_Bandwidth_Version1_Usage
SoftLayer_Container_Network_Bandwidth_Version1_Usage models an hourly bandwidth record.
-
SoftLayer_Container_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader
The SoftLayer_Container_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader data type contains information for specific responses from the modify response header API.
-
SoftLayer_Container_Network_CdnMarketplace_Configuration_Behavior_TokenAuth
The SoftLayer_Container_Network_CdnMarketplace_Configuration_Behavior_TokenAuth data type contains information for specific responses from the Token Authentication API.
-
SoftLayer_Container_Network_CdnMarketplace_Configuration_Cache_Purge
-
SoftLayer_Container_Network_CdnMarketplace_Configuration_Cache_PurgeGroup
The SoftLayer_Container_Network_CdnMarketplace_Configuration_Cache_PurgeGroup data type contains information for specific responses from the Purge Group API. Each of the Purge Group APIs returns a collection of this type
-
SoftLayer_Container_Network_CdnMarketplace_Configuration_Cache_PurgeGroupHistory
The SoftLayer_Container_Network_CdnMarketplace_Configuration_Cache_PurgeGroupHistory data type contains information for specific responses from the Purge Group API and Purge History API.
-
SoftLayer_Container_Network_CdnMarketplace_Configuration_Input
-
SoftLayer_Container_Network_CdnMarketplace_Configuration_Mapping
-
SoftLayer_Container_Network_CdnMarketplace_Configuration_Mapping_Path
-
SoftLayer_Container_Network_CdnMarketplace_Configuration_Performance_DynamicContentAcceleration
-
SoftLayer_Container_Network_CdnMarketplace_Metrics
-
SoftLayer_Container_Network_CdnMarketplace_Vendor
-
SoftLayer_Container_Network_Directory_Listing
SoftLayer_Container_Network_Directory_Listing represents a single entry in a listing of files within a remote directory. API methods that return remote directory listings typically return arrays of SoftLayer_Container_Network_Directory_Listing objects.
-
SoftLayer_Container_Network_LoadBalancer_StatusEntry
The LoadBalancer_StatusEntry object stores information about the current status of a particular load balancer service.
It is a data container that cannot be edited, deleted, or saved.
It is returned exclusively by the getStatus method on the [SoftLayer_Network_LoadBalancer_Service](/reference/datatypes/SoftLayer_Network_LoadBalancer_Service) service
-
SoftLayer_Container_Network_Message_Delivery_Email
This datatype is deprecated and will be removed in API version 3.2.
-
SoftLayer_Container_Network_Message_Delivery_Email_Sendgrid_Account
-
SoftLayer_Container_Network_Message_Delivery_Email_Sendgrid_Account_Offering
-
SoftLayer_Container_Network_Message_Delivery_Email_Sendgrid_Account_Overview
-
SoftLayer_Container_Network_Message_Delivery_Email_Sendgrid_Account_Profile
-
SoftLayer_Container_Network_Message_Delivery_Email_Sendgrid_Catalog_Item
-
SoftLayer_Container_Network_Message_Delivery_Email_Sendgrid_Catalog_Item_Entitlements
-
SoftLayer_Container_Network_Message_Delivery_Email_Sendgrid_Catalog_Item_Offering
-
SoftLayer_Container_Network_Message_Delivery_Email_Sendgrid_Customer_Profile
-
SoftLayer_Container_Network_Message_Delivery_Email_Sendgrid_List_Entry
-
SoftLayer_Container_Network_Message_Delivery_Email_Sendgrid_Statistics
-
SoftLayer_Container_Network_Message_Delivery_Email_Sendgrid_Statistics_Graph
-
SoftLayer_Container_Network_Message_Delivery_Email_Sendgrid_Statistics_Options
-
SoftLayer_Container_Network_Port_Statistic
-
SoftLayer_Container_Network_SecurityGroup_Limit
-
SoftLayer_Container_Network_Service_Resource_ObjectStorage_ConnectionInformation
-
SoftLayer_Container_Network_Storage_Backup_Evault_WebCc_Authentication_Details
-
SoftLayer_Container_Network_Storage_DataCenterLimits_VolumeCountLimitContainer
-
SoftLayer_Container_Network_Storage_DuplicateConversionStatusInformation
-
SoftLayer_Container_Network_Storage_Evault_Vault_Task
SoftLayer's StorageLayer Evault services provides details regarding the the purchased vault.
When a job is created using the Webcc Console, the job created is identified as a task on the vault. Using this service, information regarding the task can be retrieved.
-
SoftLayer_Container_Network_Storage_Evault_WebCc_AgentStatus
The SoftLayer_Container_Network_Storage_Evault_WebCc_AgentStatus will contain the timestamp of the last backup performed by the EVault agent. The agent status will also be returned.
-
SoftLayer_Container_Network_Storage_Evault_WebCc_BackupResults
The SoftLayer_Container_Network_Storage_Evault_WebCc_BackupResults will contain the timeframe of backups and the results will also be returned.
-
SoftLayer_Container_Network_Storage_Evault_WebCc_JobDetails
The SoftLayer_Container_Network_Storage_Evault_WebCc_JobDetails will contain basic details for all backup and restore jobs performed by the StorageLayer EVault service offering.
-
SoftLayer_Container_Network_Storage_Host
The SoftLayer_Container_Network_Storage_Host will contain the reference id field for the object associated with the host. The host object type will also be returned.
-
SoftLayer_Container_Network_Storage_HostsGatewayInformation
The SoftLayer_Container_Network_Storage_HostsGatewayInformation will contain the reference id field for the object associated with the host. The host object type will also be returned.
-
SoftLayer_Container_Network_Storage_Hub_ObjectStorage_Bucket
SoftLayer_Container_Network_Storage_Hub_ObjectStorage_Bucket provides description of a bucket
-
SoftLayer_Container_Network_Storage_Hub_ObjectStorage_ContentDeliveryUrl
SoftLayer_Container_Network_Storage_Hub_ObjectStorage_ContentDeliveryUrl provides specific details is a container which contains the cdn urls associated with an object storage account
-
SoftLayer_Container_Network_Storage_Hub_ObjectStorage_Endpoint
SoftLayer_Container_Network_Storage_Hub_ObjectStorage_Endpoint provides specific details on available endpoint URLs and locations.
-
SoftLayer_Container_Network_Storage_Hub_ObjectStorage_File
SoftLayer_Container_Network_Storage_Hub_ObjectStorage_File provides specific details that only apply to files that are sent or received from CloudLayer storage resources.
-
SoftLayer_Container_Network_Storage_Hub_ObjectStorage_Folder
SoftLayer_Container_Network_Storage_Hub_Container provides details about containers which store collections of files.
-
SoftLayer_Container_Network_Storage_Hub_ObjectStorage_Node
SoftLayer_Container_Network_Storage_Hub_ObjectStorage_Node provides detailed information for a particular object storage node
-
SoftLayer_Container_Network_Storage_Hub_ObjectStorage_Policy
SoftLayer_Container_Network_Storage_Hub_ObjectStorage_Policy provides specific details on available storage policies.
-
SoftLayer_Container_Network_Storage_Hub_ObjectStorage_Provision
SoftLayer_Container_Network_Storage_Hub_ObjectStorage_Provision provides description of a provision
-
SoftLayer_Container_Network_Storage_MassDataMigration_Request_Address
-
SoftLayer_Container_Network_Storage_NetworkConnectionInformation
-
SoftLayer_Container_Network_Storage_VolumeDuplicateParameters
Container for Volume Duplicate Information
-
SoftLayer_Container_Network_Subnet_IpAddress
SoftLayer_Container_Subnet_IPAddress models an IP v4 address as it exists as a member of it's subnet, letting the user know if it is a network identifier, gateway, broadcast, or useable address. Addresses that are neither the network identifier nor the gateway nor the broadcast addresses are usable by SoftLayer servers.
-
SoftLayer_Container_Network_Subnet_Registration_SubnetReference
SoftLayer_Container_Network_Subnet_Registration_SubnetReference is provided to reference [SoftLayer_Network_Subnet_Registration](/reference/datatypes/SoftLayer_Network_Subnet_Registration) object and the [SoftLayer_Network_Subnet](/reference/datatypes/SoftLayer_Network_Subnet) it references, in CIDR form.
-
SoftLayer_Container_Network_Subnet_Registration_TransactionDetails
SoftLayer_Container_Subnet_Registration_TransactionDetails is provided to return details of a newly created Subnet Registration Transaction.
-
SoftLayer_Container_Policy_Acceptance
Represents the acceptance status of a Policy.
-
SoftLayer_Container_Product_Item_Category
The SoftLayer_Container_Product_Item_Category data type represents a single product item category.
-
SoftLayer_Container_Product_Item_Category_Question_Answer
The SoftLayer_Container_Product_Item_Category_Question_Answer data type represents an answer to an item category question. It contains the category, the question being answered, and the answer.
-
SoftLayer_Container_Product_Item_Category_ZeroFee_Count
The SoftLayer_Container_Product_Item_Category_ZeroFee_Count data type represents a count of zero fee billing/invoice items.
-
SoftLayer_Container_Product_Item_Discount_Program
The SoftLayer_Container_Product_Item_Discount_Program data type represents the information about a discount that is related to a specific product item.
-
SoftLayer_Container_Product_Order
This is the datatype that needs to be populated and sent to SoftLayer_Product_Order::placeOrder. This datatype has everything required to place an order with SoftLayer.
-
SoftLayer_Container_Product_Order_Account_Media_Data_Transfer_Request
This datatype is to be used for data transfer requests.
-
SoftLayer_Container_Product_Order_Attribute_Address
This is the datatype that needs to be populated and sent to SoftLayer_Product_Order::placeOrder. The SoftLayer_Container_Product_Order_Attribute_Address datatype contains the address information.
-
SoftLayer_Container_Product_Order_Attribute_Contact
This is the datatype that needs to be populated and sent to SoftLayer_Product_Order::placeOrder. The SoftLayer_Container_Product_Order_Attribute_Contact datatype contains the contact information.
-
SoftLayer_Container_Product_Order_Attribute_Organization
This is the datatype that needs to be populated and sent to SoftLayer_Product_Order::placeOrder. The SoftLayer_Container_Product_Order_Attribute_Organization datatype contains the organization information.
-
SoftLayer_Container_Product_Order_Billing_Information
This is the datatype that needs to be populated and sent to SoftLayer_Product_Order::placeOrder. This datatype has everything required to place an order with SoftLayer.
-
SoftLayer_Container_Product_Order_Gateway_Appliance_Cluster
This is the datatype that needs to be populated and sent to SoftLayer_Product_Order::placeOrder. This datatype has everything required to place a Gateway Appliance Cluster order with SoftLayer.
-
SoftLayer_Container_Product_Order_Gateway_Appliance_Upgrade
This is the datatype that needs to be populated and sent to SoftLayer_Product_Order::placeOrder. This datatype has everything required to upgrade a [SoftLayer_Network_Gateway](/reference/datatypes/SoftLayer_Network_Gateway).
-
SoftLayer_Container_Product_Order_Hardware_Security_Module
This is the datatype that needs to be populated and sent to SoftLayer_Product_Order::placeOrder. This datatype has everything required to place a hardware security module order with SoftLayer.
-
SoftLayer_Container_Product_Order_Hardware_Server
This is the datatype that needs to be populated and sent to SoftLayer_Product_Order::placeOrder. This datatype has everything required to place an order with SoftLayer.
-
SoftLayer_Container_Product_Order_Hardware_Server_Colocation
This is the datatype that needs to be populated and sent to SoftLayer_Product_Order::placeOrder. This datatype has everything required to place an order with SoftLayer.
-
SoftLayer_Container_Product_Order_Hardware_Server_Gateway_Appliance
This is the datatype that needs to be populated and sent to SoftLayer_Product_Order::placeOrder. This datatype has everything required to place a Gateway Appliance order.
-
SoftLayer_Container_Product_Order_Hardware_Server_Upgrade
This is the datatype that needs to be populated and sent to SoftLayer_Product_Order::placeOrder. This datatype has everything required to place a hardware upgrade.
-
SoftLayer_Container_Product_Order_Hardware_Server_Upgrade_MigrateToReserved
Use this datatype to upgrade your existing monthly-billed server to term based pricing. Only monthly to 1 year, and 1 year to 3 year migrations are available. A new billing agreement contract will be created upon order approval, starting at the next billing cycle. A price is required for each existing billing item and all term-based prices must match in length. Hourly billed servers are not eligible for this upgrade. Downgrading to a shorter term is not available. Multiple term upgrades per billing cycle are not allowed.
-
SoftLayer_Container_Product_Order_Hardware_Server_Vpc
-
SoftLayer_Container_Product_Order_Monitoring_Package
This is the datatype that needs to be populated and sent to SoftLayer_Product_Order::placeOrder. This datatype has everything required to place a Monitoring Package order with SoftLayer. This class is no longer available.
-
SoftLayer_Container_Product_Order_MultiConfiguration
This is a datatype used with multi-configuration deployments. Multi-configuration deployments also have a deployment specific datatype that should be used in lieu of this one.
-
SoftLayer_Container_Product_Order_MultiConfiguration_Tornado
-
SoftLayer_Container_Product_Order_Network
(DEPRECATED) This type contains the structure of network-related objects that may be specified when ordering services.
-
SoftLayer_Container_Product_Order_Network_Application_Delivery_Controller
This is the datatype that needs to be populated and sent to SoftLayer_Product_Order::placeOrder. This datatype has everything required to place an application delivery controller order with SoftLayer.
-
SoftLayer_Container_Product_Order_Network_Interconnect
This is the datatype that needs to be populated and sent to SoftLayer_Product_Order::placeOrder when purchasing a Network Interconnect.
-
SoftLayer_Container_Product_Order_Network_Interconnect_Upgrade
This is the datatype that needs to be populated and sent to SoftLayer_Product_Order::placeOrder. This datatype has everything required to place an upgrade order for Direct Link.
-
SoftLayer_Container_Product_Order_Network_LoadBalancer
This is the default container type for network load balancer orders.
-
SoftLayer_Container_Product_Order_Network_LoadBalancer_AsAService
This is the datatype that needs to be populated and sent to SoftLayer_Product_Order::placeOrder. This datatype has everything required to place an order for a Load Balancer as a Service.
-
SoftLayer_Container_Product_Order_Network_Message_Delivery
This is the datatype that needs to be populated and sent to SoftLayer_Product_Order::placeOrder. This datatype has everything required to place a network message delivery order with SoftLayer.
-
SoftLayer_Container_Product_Order_Network_Message_Delivery_Upgrade
This is the datatype that needs to be populated and sent to SoftLayer_Product_Order::placeOrder. This datatype has everything required to place an upgrade order for network message delivery.
-
SoftLayer_Container_Product_Order_Network_PerformanceStorage
This is the base data type for Performance storage order containers. If you wish to place an order you must not use this class and instead use the appropriate child container for the type of storage you would like to order: [SoftLayer_Container_Product_Order_Network_PerformanceStorage_Nfs](/reference/datatypes/SoftLayer_Container_Product_Order_Network_PerformanceStorage_Nfs) for File and [SoftLayer_Container_Product_Order_Network_PerformanceStorage_Iscsi](/reference/datatypes/SoftLayer_Container_Product_Order_Network_PerformanceStorage_Iscsi) for Block storage.
-
SoftLayer_Container_Product_Order_Network_PerformanceStorage_Iscsi
This is the datatype that needs to be populated and sent to SoftLayer_Product_Order::placeOrder. This datatype has everything required to place an order for iSCSI (Block) Performance Storage
-
SoftLayer_Container_Product_Order_Network_PerformanceStorage_Nfs
This is the datatype that needs to be populated and sent to SoftLayer_Product_Order::placeOrder. This datatype has everything required to place an order for NFS (File) Performance Storage
-
SoftLayer_Container_Product_Order_Network_Protection_Firewall
This is the datatype that needs to be populated and sent to SoftLayer_Product_Order::placeOrder. This datatype has everything required to place a hardware firewall order with SoftLayer.
-
SoftLayer_Container_Product_Order_Network_Protection_Firewall_Dedicated
This is the datatype that needs to be populated and sent to SoftLayer_Product_Order::placeOrder. This datatype has everything required to place a hardware (dedicated) firewall order with SoftLayer.
-
SoftLayer_Container_Product_Order_Network_Protection_Firewall_Dedicated_Upgrade
This is the datatype that needs to be populated and sent to SoftLayer_Product_Order::placeOrder. This datatype has everything required to place an order with SoftLayer.
-
SoftLayer_Container_Product_Order_Network_Storage_AsAService
This is the datatype that needs to be populated and sent to SoftLayer_Product_Order::placeOrder. This datatype has everything required to place an order for Storage as a Service.
-
SoftLayer_Container_Product_Order_Network_Storage_AsAService_Upgrade
This is the datatype that needs to be populated and sent to SoftLayer_Product_Order::placeOrder. This datatype has everything required to place an upgrade order for Storage as a Service.
-
SoftLayer_Container_Product_Order_Network_Storage_Backup_Evault_Plugin
This is the datatype that needs to be populated and sent to SoftLayer_Product_Order::placeOrder. This datatype has everything required to place an order for additional Evault plugins.
-
SoftLayer_Container_Product_Order_Network_Storage_Backup_Evault_Vault
This is the datatype that needs to be populated and sent to SoftLayer_Product_Order::placeOrder. This datatype has everything required to place an Evault order with SoftLayer.
-
SoftLayer_Container_Product_Order_Network_Storage_Enterprise
This is the datatype that needs to be populated and sent to SoftLayer_Product_Order::placeOrder. This datatype has everything required to place an order for Enterprise Storage
-
SoftLayer_Container_Product_Order_Network_Storage_Enterprise_SnapshotSpace
This is the datatype that needs to be populated and sent to SoftLayer_Product_Order::placeOrder. This datatype has everything required to place an order for Enterprise Storage Snapshot Space.
-
SoftLayer_Container_Product_Order_Network_Storage_Enterprise_SnapshotSpace_Upgrade
This is the datatype that needs to be populated and sent to SoftLayer_Product_Order::placeOrder. This datatype has everything required to place an upgrade order for Enterprise Storage Snapshot Space.
-
SoftLayer_Container_Product_Order_Network_Storage_Hub
This datatype is to be used for object storage orders.
-
SoftLayer_Container_Product_Order_Network_Storage_Hub_Datacenter
This class is used to contain a datacenter location and its associated active usage rate prices for object storage ordering.
-
SoftLayer_Container_Product_Order_Network_Storage_Iscsi
This is the datatype that needs to be populated and sent to SoftLayer_Product_Order::placeOrder. This datatype has everything required to place an ISCSI order with SoftLayer.
-
SoftLayer_Container_Product_Order_Network_Storage_MassDataMigration_Request
This datatype is to be used for mass data migration requests.
-
SoftLayer_Container_Product_Order_Network_Storage_Modification
The SoftLayer_Container_Product_Order_Network_Storage_Modification datatype has everything required to place a modification to an existing StorageLayer account with SoftLayer. Modifications, at present time, include upgrade and downgrades only. The ''volumeId'' property must be set to the network storage volume id to be upgraded. Once populated send this container to the [SoftLayer_Product_Order::placeOrder](/reference/datatypes/$1/#$2) method.
The ''packageId'' property passed in for CloudLayer storage accounts must be set to 0 (zero) and the ''quantity'' property must be set to 1. The location does not have to be set. Please use the [SoftLayer_Product_Package](/reference/datatypes/SoftLayer_Product_Package) service to retrieve a list of CloudLayer items.
NOTE: When upgrading CloudLayer storage service from a metered plan (pay as you go) to a non-metered plan, make sure the chosen plan's storage allotment has enough space to cover the current usage. If the chosen plan's usage allotment is less than the CloudLayer storage's usage the order will be rejected.
-
SoftLayer_Container_Product_Order_Network_Storage_Nas
This is the datatype that needs to be populated and sent to SoftLayer_Product_Order::placeOrder when placing network attached storage orders.
-
SoftLayer_Container_Product_Order_Network_Storage_Object
This datatype is to be used for ordering object storage products using the object_storage [SoftLayer_Product_Item_Category](/reference/datatypes/SoftLayer_Product_Item_Category). For object storage products using hub [SoftLayer_Product_Item_Category](/reference/datatypes/SoftLayer_Product_Item_Category) use the [SoftLayer_Container_Product_Order_Network_Storage_Hub](/reference/datatypes/SoftLayer_Container_Product_Order_Network_Storage_Hub) order container.
-
SoftLayer_Container_Product_Order_Network_Storage_ObjectStorage_LocationGroup
This class is used to contain a location group and its associated active usage rate prices for object storage ordering.
-
SoftLayer_Container_Product_Order_Network_Subnet
This is the datatype that needs to be populated and sent to SoftLayer_Product_Order::placeOrder. This datatype has everything required to place a subnet order with SoftLayer.
-
SoftLayer_Container_Product_Order_Network_Tunnel_Ipsec
This is the datatype that needs to be populated and sent to SoftLayer_Product_Order::placeOrder. This datatype has everything required to place a network ipsec vpn order with SoftLayer.
-
SoftLayer_Container_Product_Order_Network_Vlan
This is the datatype that needs to be populated and sent to SoftLayer_Product_Order::placeOrder. This datatype has everything required to place a network vlan order with SoftLayer.
-
SoftLayer_Container_Product_Order_Network_Vlans
This class contains the collections of public and private VLANs that are available during the ordering process.
-
SoftLayer_Container_Product_Order_NewCustomerSetup
This is the datatype that needs to be populated and sent to SoftLayer_Product_Order::placeOrder when linking a Bluemix account to a newly created SoftLayer account.
-
SoftLayer_Container_Product_Order_Private_Cloud
This is the datatype that needs to be populated and sent to SoftLayer_Product_Order::placeOrder. This datatype has everything required to place an order for Private Cloud.
-
SoftLayer_Container_Product_Order_Property
This is used for storing various items about the order. Currently used for storing additional raid information when ordering servers. This is optional
-
SoftLayer_Container_Product_Order_Receipt
When an order is placed (SoftLayer_Product_Order::placeOrder), a receipt is returned when the order is created successfully. The information in the receipt helps explain information about the order. It's order ID, and all the data within the order as well.
For PayPal Orders, an URL is also returned to the user so that the user can complete the transaction. Users paying with PayPal must continue on to this URL, login and pay. When doing this, PayPal will redirect the user back to a SoftLayer page which will then 'finalize' the authorization process. From here, Sales will verify the order by contacting the user in some way, unless sales has already spoken to the user about approving the order.
For users paying with a credit card, a receipt means the order has gone to sales and is awaiting approval.
-
SoftLayer_Container_Product_Order_Security_Certificate
This is the datatype that needs to be populated and sent to SoftLayer_Product_Order::placeOrder. This datatype contains everything required to place a secure certificate order with SoftLayer.
-
SoftLayer_Container_Product_Order_Service
This is the datatype that needs to be populated and sent to SoftLayer_Product_Order::placeOrder.
-
SoftLayer_Container_Product_Order_Service_External
This is the datatype that needs to be populated and sent to SoftLayer_Product_Order::placeOrder.
-
SoftLayer_Container_Product_Order_Software_Component_Virtual
This is the datatype that needs to be populated and sent to SoftLayer_Product_Order::placeOrder. This datatype has everything required to place a virtual license order with SoftLayer.
-
SoftLayer_Container_Product_Order_Software_License
This is the datatype that needs to be populated and sent to SoftLayer_Product_Order::placeOrder. This datatype has everything required to place a hardware security module order with SoftLayer.
-
SoftLayer_Container_Product_Order_SshKeys
This object holds all of the ssh key ids that will allow authentication to a single server.
-
SoftLayer_Container_Product_Order_Storage_Group
A single storage group container used for a hardware server order.
This object describes a single storage group that can be added to an order container.
-
SoftLayer_Container_Product_Order_Storage_Group_Partition
A storage group partition container used for a hardware server order.
This object describes the partitions for a single storage group that can be added to an order container.
-
SoftLayer_Container_Product_Order_Support
When ordering paid support this datatype needs to be populated and sent to SoftLayer_Product_Order::placeOrder.
-
SoftLayer_Container_Product_Order_User_Customer_External_Binding
This container type is used for placing orders for external authentication, such as phone-based authentication.
-
SoftLayer_Container_Product_Order_Virtual_DedicatedHost
This is the default container type for Dedicated Virtual Host orders.
-
SoftLayer_Container_Product_Order_Virtual_Disk_Image
This is the datatype that needs to be populated and sent to SoftLayer_Product_Order::placeOrder. This datatype has everything required to place a Portable Storage order with SoftLayer.
-
SoftLayer_Container_Product_Order_Virtual_Guest
This is the datatype that needs to be populated and sent to SoftLayer_Product_Order::placeOrder. This datatype has everything required to place an order with SoftLayer.
-
SoftLayer_Container_Product_Order_Virtual_Guest_Upgrade
This is the datatype that needs to be populated and sent to SoftLayer_Product_Order::placeOrder. This datatype has everything required to place an order with SoftLayer.
-
SoftLayer_Container_Product_Order_Virtual_Guest_Vpc
-
SoftLayer_Container_Product_Order_Virtual_Guest_Vpc_NetworkInterface
-
SoftLayer_Container_Product_Order_Virtual_Guest_Vpc_StorageVolume
-
SoftLayer_Container_Product_Order_Virtual_Guest_Vpc_Upgrade
-
SoftLayer_Container_Product_Order_Virtual_ReservedCapacity
This is the default container type for Reserved Capacity orders.
-
SoftLayer_Container_Product_Order_Vpc_IpAllocation
-
SoftLayer_Container_Product_Order_Vpc_Subnet
-
SoftLayer_Container_Product_Promotion
The SoftLayer_Container_Product_Promotion data type contains information about a promotion and its requirements.
-
SoftLayer_Container_Product_Promotion_RequirementGroup
The SoftLayer_Container_Product_Promotion_RequirementGroup data type contains the required options that must be present on an order for the promotion to be applied. At least one of the categories, presets, or prices must be on the order.
-
SoftLayer_Container_Provisioning_Maintenance_Window
This is the datatype that needs to be populated and sent to SoftLayer_Provisioning_Maintenance_Window::addCustomerUpgradeWindow. This datatype has everything required to place an order with SoftLayer.
-
SoftLayer_Container_Referral_Partner_Commission
-
SoftLayer_Container_Referral_Partner_Payment_Option
-
SoftLayer_Container_Referral_Partner_Prospect
-
SoftLayer_Container_RemoteManagement_Graphs_SensorSpeed
The SoftLayer_Container_RemoteManagement_Graphs_SensorSpeed contains graphs to display speed for each of the server's fans. Fan speeds are gathered from the server's remote management card.
-
SoftLayer_Container_RemoteManagement_Graphs_SensorTemperature
The SoftLayer_Container_RemoteManagement_Graphs_SensorTemperature contains graphs to display the cpu(s) and system temperatures retrieved from the management card using thermometer graphs.
-
SoftLayer_Container_RemoteManagement_PmInfo
The SoftLayer_Container_RemoteManagement_PmInfo contains pminfo information retrieved from a server's remote management card.
-
SoftLayer_Container_RemoteManagement_SensorReading
The SoftLayer_Container_RemoteManagement_SensorReadings contains sensor information retrieved from a server's remote management card.
-
SoftLayer_Container_RemoteManagement_SensorReadingsWithGraphs
The SoftLayer_Container_RemoteManagement_SensorReadingsWithGraphs contains the raw data retrieved from a server's remote management card. Along with the raw data, two sets of graphs will be returned. One set of graphs is used to display, using thermometer graphs, the temperatures (cpu(s) and system) retrieved from the management card. The other set is used to display speed for each of the server's fans.
-
SoftLayer_Container_Resource_Metadata_ServiceResource
The metadata service resource container is used to store information about a single service resource.
-
SoftLayer_Container_Search_ObjectType
This data type is a container that stores information about a single indexed object type. Object type information can be used for discovery of searchable data and for creation or validation of object index search strings. Each of these containers holds a collection of <b>[SoftLayer_Container_Search_ObjectType_Property](/reference/datatypes/SoftLayer_Container_Search_ObjectType_Property)</b> objects, specifying which object properties are exposed for the current user. Refer to the the documentation for the <b>[SoftLayer_Search::search](/reference/services/SoftLayer_Search/search)</b> method for information on using object types in search strings.
-
SoftLayer_Container_Search_ObjectType_Property
This data type is a container that stores information about a single property of a searchable object type. Each <b>[SoftLayer_Container_Search_ObjectType](/reference/datatypes/SoftLayer_Container_Search_ObjectType)</b> object holds a collection of these properties. Property information can be used for discovery of searchable data and for the creation or validation of object index search strings. Note that properties are only understood by the <b>[SoftLayer_Search::advancedSearch](/reference/services/SoftLayer_Search/advancedSearch)</b> method. Refer to the <b>advancedSearch()</b> method for information on using properties in search strings.
-
SoftLayer_Container_Search_Result
The SoftLayer_Container_Search_Result data type represents a result row from an execution of Search service.
-
SoftLayer_Container_Software_Component_HostIps_Policy
The SoftLayer_Container_Software_Component_HostIps_Policy container holds the title and value of a current host ips policy.
-
SoftLayer_Container_Tax_Cache
These are the results of a tax calculation. The tax calculation was kicked off but allowed to run in the background. This type stores the results so that an interface can be updated with up-to-date information.
-
SoftLayer_Container_Tax_Cache_Item
This represents one order item in a tax calculation.
-
SoftLayer_Container_Tax_Rates
This contains the four tax rates, one for each fee type.
-
SoftLayer_Container_Ticket_GraphInputs
SoftLayer_Container_Ticket_GraphInputs models a single inbound object for a given ticket graph.
-
SoftLayer_Container_Ticket_GraphOutputs
SoftLayer_Container_Ticket_GraphOutputs models a single outbound object for a given bandwidth graph.
-
SoftLayer_Container_Ticket_Priority
-
SoftLayer_Container_Ticket_Survey_Preference
-
SoftLayer_Container_User_Authentication_Token
Container class used to hold user authentication token
-
SoftLayer_Container_User_Customer_External_Binding
Container classed used to hold external authentication information
-
SoftLayer_Container_User_Customer_External_Binding_Totp
Container classed used to hold portal token
-
SoftLayer_Container_User_Customer_External_Binding_Vendor
Container classed used to hold details about an external authentication vendor.
-
SoftLayer_Container_User_Customer_External_Binding_Verisign
Container classed used to hold portal token
-
SoftLayer_Container_User_Customer_OpenIdConnect_LoginAccountInfo
-
SoftLayer_Container_User_Customer_OpenIdConnect_MigrationState
-
SoftLayer_Container_User_Customer_PasswordSet
Container for holding information necessary for the setting and resetting of customer passwords
-
SoftLayer_Container_User_Customer_Portal_MobileToken
Container classed used to hold mobile portal token
-
SoftLayer_Container_User_Customer_Portal_Token
Container classed used to hold portal token
-
SoftLayer_Container_User_Customer_Profile_Event_HyperWarp_ProfileChange
-
SoftLayer_Container_User_Customer_Profile_Event_HyperWarp_ProfileChange_Context
-
SoftLayer_Container_User_Customer_Profile_Event_HyperWarp_ProfileChange_EventProperties
-
SoftLayer_Container_User_Employee_External_Binding_Verisign
Container classed used to hold portal token
-
SoftLayer_Container_Utility_File_Attachment
At times,such as when attaching files to tickets, it is necessary to send files to SoftLayer API methods. The SoftLayer_Container_Utility_File_Attachment data type models a single file to upload to the API.
-
SoftLayer_Container_Utility_File_Entity
SoftLayer_Container_Utility_File_Entity data type models a single entity on a storage resource. Entities can include anything within a storage volume including files, folders, directories, and CloudLayer storage projects.
-
SoftLayer_Container_Utility_Message
-
SoftLayer_Container_Utility_Microsoft_Windows_UpdateServices_Status
SoftLayer customer servers that are purchased with the Microsoft Windows operating system are configured by default to retrieve updates from SoftLayer's local Windows Server Update Services (WSUS) server. Periodically, these servers synchronize and check for new updates from their local WSUS server. SoftLayer_Container_Utility_Microsoft_Windows_UpdateServices_Status models the results of a server's last synchronization attempt as queried from SoftLayer's WSUS servers.
-
SoftLayer_Container_Utility_Microsoft_Windows_UpdateServices_UpdateItem
SoftLayer_Container_Utility_Microsoft_Windows_UpdateServices_UpdateItem models a single Microsoft Update as reported by SoftLayer's private Windows Server Update Services (WSUS) services. All servers purchased with Microsoft Windows retrieve updates from SoftLayer's WSUS servers by default.
-
SoftLayer_Container_Utility_Network_Firewall_Rule_Attribute
The SoftLayer_Container_Utility_Network_Firewall_Rule_Attribute data type contains information relating to a single firewall rule.
-
SoftLayer_Container_Utility_Network_Subnet_Mask_Generic_Detail
The SoftLayer_Container_Utility_Network_Subnet_Mask_Generic_Detail data type contains information relating to a subnet mask and details associated with that object.
-
SoftLayer_Container_Virtual_ConsoleData
The SoftLayer_Container_Virtual_ConsoleData data type contains information used to access a VSIs console
-
SoftLayer_Container_Virtual_DedicatedHost_AllocationStatus
This data type represents the structure to hold the allocation properties of a [SoftLayer_Virtual_DedicatedHost](/reference/datatypes/SoftLayer_Virtual_DedicatedHost).
-
SoftLayer_Container_Virtual_DedicatedHost_Pci_Device_AllocationStatus
This data type represents PCI device allocation properties of a [SoftLayer_Virtual_DedicatedHost](/reference/datatypes/SoftLayer_Virtual_DedicatedHost).
-
SoftLayer_Container_Virtual_Guest_Block_Device_Template_Configuration
The SoftLayer_Container_Virtual_Guest_Block_Device_Template_Configuration data type contains information relating to a template's external location for importing and exporting
-
SoftLayer_Container_Virtual_Guest_Block_Device_Template_Group_RiasAccount
-
SoftLayer_Container_Virtual_Guest_Configuration
The guest configuration container is used to provide configuration options for creating computing instances.
Each configuration option will include both an <code>itemPrice</code> and a <code>template</code>.
The <code>itemPrice</code> value will provide hourly and monthly costs (if either are applicable), and a description of the option.
The <code>template</code> will provide a fragment of the request with the properties and values that must be sent when creating a computing instance with the option.
The [SoftLayer_Virtual_Guest::getCreateObjectOptions](/reference/services/SoftLayer_Virtual_Guest/getCreateObjectOptions) method returns this data structure.
<style type='text/css'>#properties .views-field-body p { margin-top: 1.5em; };</style>
-
SoftLayer_Container_Virtual_Guest_Configuration_Option
An option found within a [SoftLayer_Container_Virtual_Guest_Configuration](/reference/datatypes/SoftLayer_Container_Virtual_Guest_Configuration) structure.
-
SoftLayer_Container_Virtual_Guest_PendingMaintenanceAction
The SoftLayer_Container_Virtual_Guest_PendingMaintenanceAction data type contains information relating to a SoftLayer_Virtual_Guest's pending maintenance actions.
-
SoftLayer_Device_Status
SoftLayer_Device_Status is used to indicate the current status of a device
-
SoftLayer_Dns_Domain
The SoftLayer_Dns_Domain data type represents a single DNS domain record hosted on the SoftLayer nameservers. Domains contain general information about the domain name such as name and serial. Individual records such as A, AAAA, CTYPE, and MX records are stored in the domain's associated [SoftLayer_Dns_Domain_ResourceRecord](/reference/datatypes/SoftLayer_Dns_Domain_ResourceRecord) records.
-
SoftLayer_Dns_Domain_Forward
The SoftLayer_Dns_Domain_Forward data type represents a single DNS domain record hosted on the SoftLayer nameservers. Domains contain general information about the domain name such as name and serial. Individual records such as A, AAAA, CTYPE, and MX records are stored in the domain's associated [SoftLayer_Dns_Domain_ResourceRecord](/reference/datatypes/SoftLayer_Dns_Domain_ResourceRecord) records.
-
SoftLayer_Dns_Domain_ResourceRecord
The SoftLayer_Dns_Domain_ResourceRecord data type represents a single resource record entry in a SoftLayer hosted domain. Each resource record contains a ''host'' and ''data'' property, defining a resource's name and it's target data. Domains contain multiple types of resource records. The ''type'' property separates out resource records by type. ''Type'' can take one of the following values: * ''''a'''' for [SoftLayer_Dns_Domain_ResourceRecord_AType](/reference/datatypes/SoftLayer_Dns_Domain_ResourceRecord_AType) records * ''''aaaa'''' for [SoftLayer_Dns_Domain_ResourceRecord_AaaaType](/reference/datatypes/SoftLayer_Dns_Domain_ResourceRecord_AaaaType) records * ''''cname'''' for [SoftLayer_Dns_Domain_ResourceRecord_CnameType](/reference/datatypes/SoftLayer_Dns_Domain_ResourceRecord_CnameType) records * ''''mx'''' for [SoftLayer_Dns_Domain_ResourceRecord_MxType](/reference/datatypes/SoftLayer_Dns_Domain_ResourceRecord_MxType) records * ''''ns'''' for [SoftLayer_Dns_Domain_ResourceRecord_NsType](/reference/datatypes/SoftLayer_Dns_Domain_ResourceRecord_NsType) records * ''''ptr'''' for [SoftLayer_Dns_Domain_ResourceRecord_PtrType](/reference/datatypes/SoftLayer_Dns_Domain_ResourceRecord_PtrType) records in reverse domains * ''''soa'''' for a domain's [SoftLayer_Dns_Domain_ResourceRecord_SoaType](/reference/datatypes/SoftLayer_Dns_Domain_ResourceRecord_SoaType) record * ''''spf'''' for [SoftLayer_Dns_Domain_ResourceRecord_SpfType](/reference/datatypes/SoftLayer_Dns_Domain_ResourceRecord_SpfType) records * ''''srv'''' for [SoftLayer_Dns_Domain_ResourceRecord_SrvType](/reference/datatypes/SoftLayer_Dns_Domain_ResourceRecord_SrvType) records * ''''txt'''' for [SoftLayer_Dns_Domain_ResourceRecord_TxtType](/reference/datatypes/SoftLayer_Dns_Domain_ResourceRecord_TxtType) records
As ''SoftLayer_Dns_Domain_ResourceRecord'' objects are created and loaded, the API verifies the ''type'' property and casts the object as the appropriate type.
-
SoftLayer_Dns_Domain_ResourceRecord_AaaaType
SoftLayer_Dns_Domain_ResourceRecord_AaaaType is a SoftLayer_Dns_Domain_ResourceRecord object whose ''type'' property is set to 'aaaa' and defines a DNS AAAA record on a SoftLayer hosted domain. An AAAA record directs a host name to an IPv6 address. For instance if the AAAA record for 'host.example.org' points to the IPv6 address 'fe80:0:0:0:0:0:a00:0' then the ''host'' property for the AAAA record equals 'host' and the ''data'' property equals 'fe80:0:0:0:0:0:a00:0'.
-
SoftLayer_Dns_Domain_ResourceRecord_AType
SoftLayer_Dns_Domain_ResourceRecord_AType is a SoftLayer_Dns_Domain_ResourceRecord object whose ''type'' property is set to 'a' and defines a DNS A record on a SoftLayer hosted domain. An A record directs a host name to an IP address. For instance if the A record for 'host.example.org' points to the IP address 10.0.0.1 then the ''host'' property for the A record equals 'host' and the ''data'' property equals '10.0.0.1'.
-
SoftLayer_Dns_Domain_ResourceRecord_CnameType
SoftLayer_Dns_Domain_ResourceRecord_CnameType is a SoftLayer_Dns_Domain_ResourceRecord object whose ''type'' property is set to 'cname' and defines a DNS CNAME record on a SoftLayer hosted domain. A CNAME record directs a host name to another host. For instance, if the CNAME record for 'alias.example.org' points to the host 'host.example.org' then the ''host'' property equals 'alias' and the ''data'' property equals 'host.example.org.'.
DNS entries defined by CNAME should not be used as the data field for an MX record.
-
SoftLayer_Dns_Domain_ResourceRecord_MxType
SoftLayer_Dns_Domain_ResourceRecord_MxType is a SoftLayer_Dns_Domain_ResourceRecord object whose ''type'' property is set to 'mx' and used to describe MX resource records. MX records control which hosts are responsible as mail exchangers for a domain. For instance, in the domain example.org, an MX record whose host is '@' and data is 'mail' says that the host 'mail.example.org' is responsible for handling mail for example.org. That means mail sent to users @example.org are delivered to mail.example.org.
Domains can have more than one MX record if it uses more than one server to send mail through. Multiple MX records are denoted by their priority, defined by the mxPriority property.
MX records must be defined for hosts with accompanying A or AAAA resource records. They may not point mail towards a host defined by a CNAME record.
-
SoftLayer_Dns_Domain_ResourceRecord_NsType
SoftLayer_Dns_Domain_ResourceRecord_NsType is a SoftLayer_Dns_Domain_ResourceRecord object whose ''type'' property is set to 'ns' and defines a DNS NS record on a SoftLayer hosted domain. An NS record defines the authoritative name server for a domain. All SoftLayer hosted domains contain NS records for 'ns1.softlayer.com' and 'ns2.softlayer.com' . For instance, if example.org is hosted on ns1.softlayer.com, then example.org contains an NS record whose ''host'' property equals '@' and whose ''data'' property equals 'ns1.example.org'.
NS resource records pointing to ns1.softlayer.com or ns2.softlayer.com many not be removed from a SoftLayer hosted domain.
-
SoftLayer_Dns_Domain_ResourceRecord_PtrType
SoftLayer_Dns_Domain_ResourceRecord_PtrType is a SoftLayer_Dns_Domain_ResourceRecord object whose ''type'' property is set to 'ptr' and defines a reverse DNS PTR record on the SoftLayer name servers.
The format for a reverse DNS PTR record varies based on whether it is for an IPv4 or IPv6 address.
For an IPv4 address the ''host'' property for every PTR record is the last octet of the IP address that the PTR record belongs to, while the ''data'' property is the canonical name of the host that the reverse lookup resolves to. Every PTR record belongs to a domain on the SoftLayer name servers named by the first three octets of an IP address in reverse order followed by '.in-addr.arpa'.
For instance, if the reverse DNS record for 10.0.0.1 is 'host.example.org' then it's corresponding SoftLayer_Dns_Domain_ResourceRecord_PtrType host is '1', while it's data property equals 'host.example.org'. The full name of the reverse record for host.example.org including the domain name is '1.0.0.10.in-addr.arpa'.
For an IPv6 address the ''host'' property for every PTR record is the last four octets of the IP address that the PTR record belongs to. The last four octets need to be in reversed order and each digit separated by a period. The ''data'' property is the canonical name of the host that the reverse lookup resolves to. Every PTR record belongs to a domain on the SoftLayer name servers named by the first four octets of an IP address in reverse order, split up by digit with a period, and followed by '.ip6.arpa'.
For instance, if the reverse DNS record for fe80:0000:0000:0000:0000:0000:0a00:0001 is 'host.example.org' then it's corresponding SoftLayer_Dns_Domain_ResourceRecord_PtrType host is '1.0.0.0.0.0.a.0.0.0.0.0.0.0.0.0', while it's data property equals 'host.example.org'. The full name of the reverse record for host.example.org including the domain name is '1.0.0.0.0.0.a.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.8.e.f.ip6.arpa'.
PTR record host names may not be changed by [SoftLayer_Dns_Domain_ResourceRecord::editObject](/reference/datatypes/$1/#$2) or [SoftLayer_Dns_Domain_ResourceRecord::editObjects](/reference/datatypes/$1/#$2).
-
SoftLayer_Dns_Domain_ResourceRecord_SoaType
SoftLayer_Dns_Domain_ResourceRecord_SoaType defines a domains' Start of Authority (or SOA) resource record. A domain's SOA record contains a domain's general and propagation information. Every domain must have one SOA record, and it is not possible to remove a domain's SOA record.
SOA records typically contain a domain's serial number, but the SoftLayer API associates a domain's serial number directly with it's SoftLayer_Dns_Domain record.
-
SoftLayer_Dns_Domain_ResourceRecord_SpfType
SoftLayer_Dns_Domain_ResourceRecord_SpfType is a SoftLayer_Dns_Domain_ResourceRecord object whose ''type'' property is set to 'spf' and defines a DNS SPF record on a SoftLayer hosted domain. An SPF record provides sender policy framework data for a host. For instance, if defining the SPF record 'v=spf1 mx:mail.example.org ~all' for 'host.example.org'. then the ''host'' property equals 'host' and the ''data'' property equals 'v=spf1 mx:mail.example.org ~all'.
SPF records are commonly used in email verification methods such as Sender Policy Framework.
-
SoftLayer_Dns_Domain_ResourceRecord_SrvType
SoftLayer_Dns_Domain_ResourceRecord_SrvType is a SoftLayer_Dns_Domain_ResourceRecord object whose ''type'' property is set to 'srv' and defines a DNS SRV record on a SoftLayer hosted domain.
-
SoftLayer_Dns_Domain_ResourceRecord_TxtType
SoftLayer_Dns_Domain_ResourceRecord_TxtType is a SoftLayer_Dns_Domain_ResourceRecord object whose ''type'' property is set to 'txt' and defines a DNS TXT record on a SoftLayer hosted domain. A TXT record provides a text description for a host. For instance, if defining the TXT record 'My test host' for 'host.example.org'. then the ''host'' property equals 'host' and the ''data'' property equals 'My test host'.
TXT records are commonly used in email verification methods such as Sender Policy Framework.
-
SoftLayer_Dns_Domain_Reverse
The SoftLayer_Dns_Domain_Reverse data type represents a reverse IP address record.
-
SoftLayer_Dns_Domain_Reverse_Version4
The SoftLayer_Dns_Domain_Reverse_Version4 data type represents a reverse IPv4 address record.
-
SoftLayer_Dns_Domain_Reverse_Version6
The SoftLayer_Dns_Domain_Reverse_Version6 data type represents a reverse IPv6 address record.
-
SoftLayer_Dns_Message
The SoftLayer_Dns_Message data type contains information for a single message generated by the SoftLayer DNS system. SoftLayer_Dns_Messages are typically created during the secondary DNS transfer process.
-
SoftLayer_Dns_Secondary
The SoftLayer_Dns_Secondary data type contains information on a single secondary DNS zone which is managed through SoftLayer's zone transfer service. Domains created via zone transfer may not be modified by the SoftLayer portal or API.
-
SoftLayer_Dns_Status
The SoftLayer_Dns_Status data type contains information for a DNS status
-
SoftLayer_Email_Subscription
SoftLayer customers can use this service to manage or view all of the available email subscriptions that they can suppress.
-
SoftLayer_Email_Subscription_Group
SoftLayer customers can use this service to view the parent groups of the email subscriptions
-
SoftLayer_Email_Subscription_Suppression_User
-
SoftLayer_Entity
-
SoftLayer_Event_Log
The SoftLayer_Event_Log data type contains an event detail occurred upon various SoftLayer resources.
-
SoftLayer_Exception_Brand_Creation
Throw this exception if there are validation errors. The types are specified in SoftLayer_Brand_Creation_Input including: KEY_NAME, PREFIX, NAME, LONG_NAME, SUPPORT_POLICY, POLICY_ACKNOWLEDGEMENT_FLAG, etc.
-
SoftLayer_Exception_Hardware_Component_Locator_ComponentLocatorException
This exception is thrown if the component locator client cannot find or communicate with the component locator service.
-
SoftLayer_Exception_Hardware_Component_Locator_InvalidGenericComponentArgument
This exception is thrown if the argument is of incorrect type.
-
SoftLayer_FlexibleCredit_Affiliate
-
SoftLayer_FlexibleCredit_Company_Type
-
SoftLayer_FlexibleCredit_Enrollment
-
SoftLayer_FlexibleCredit_Program
-
SoftLayer_Hardware
The SoftLayer_Hardware data type contains general information relating to a single SoftLayer hardware.
-
SoftLayer_Hardware_Attribute
The SoftLayer_Hardware_Attribute type contains general information for a hardware attribute. Hardware attributes can be assigned to specific hardware objects to describe relatively arbitrary information.
-
SoftLayer_Hardware_Attribute_Type
Retrieve attributes associated with a hardware object.
-
SoftLayer_Hardware_Attribute_UserData
-
SoftLayer_Hardware_Benchmark_Certification
The SoftLayer_Hardware_Benchmark_Certification data type contains general information relating to a single SoftLayer hardware benchmark certification document.
-
SoftLayer_Hardware_Blade
The SoftLayer_Hardware_Blade service provides specific information about blade servers.
-
SoftLayer_Hardware_Chassis
Every piece of hardware in SoftLayer's datacenters, including customer servers, are housed in one of many hardware chassis. The SoftLayer_Hardware_Chassis data type defines these chassis.
-
SoftLayer_Hardware_Component
The SoftLayer_Hardware_Component data type abstracts information related to a hardware component.
-
SoftLayer_Hardware_Component_Attribute
The SoftLayer_Hardware_Component_Attribute data type contains general information relating to a single hardware setting or attribute for a component model. For Example: A RAID controller may be setup for many different RAID configurations. A RAID controller with a configuration of RAID-1 will have a single attribute for this RAID setting.
-
SoftLayer_Hardware_Component_Attribute_Type
The SoftLayer_Hardware_Component_Attribute_Type data type contains general information for the type of an attribute for a hardware component.
-
SoftLayer_Hardware_Component_DriveController
The SoftLayer_Hardware_Component_DriveController data type abstracts information related to a drive controller.
-
SoftLayer_Hardware_Component_Firmware
-
SoftLayer_Hardware_Component_Firmware_Attribute
The SoftLayer_Hardware_Component_Firmware_Attribute data type contains general information for a hardware model's firmware.
-
SoftLayer_Hardware_Component_Firmware_Attribute_Type
The SoftLayer_Hardware_Component_Firmware_Attribute_Type data type defines attribute types for a hardware component model's firmware.
-
SoftLayer_Hardware_Component_Firmware_QualificationTypes
The SoftLayer_Hardware_Component_Firmware_QualificationTypes data type describes the current qualification status for a particular firmware.
-
SoftLayer_Hardware_Component_HardDrive
The SoftLayer_Hardware_Component_HardDrive data type abstracts information related to a hard drive.
-
SoftLayer_Hardware_Component_Locator
SoftLayer public API to determine the availability of generic hardware component models at data centers
-
SoftLayer_Hardware_Component_Locator_Result
This object holds a generic component model id and the list of datacenter names where it is available.
-
SoftLayer_Hardware_Component_Model
The SoftLayer_Hardware_Component_Model data type contains general information relating to a single SoftLayer component model. A component model represents a vendor specific representation of a hardware component. Every piece of hardware on a server will have a specific hardware component model.
-
SoftLayer_Hardware_Component_Model_Architecture_Type
-
SoftLayer_Hardware_Component_Model_Attribute
The SoftLayer_Hardware_Component__Model_Attribute data type contains general information relating to a single hardware setting or attribute for a component model.
-
SoftLayer_Hardware_Component_Model_Attribute_Type
The SoftLayer_Hardware_Component_Model_Attribute_Type data type contains general information for the type of an attribute for a hardware component model.
-
SoftLayer_Hardware_Component_Model_Generic
The SoftLayer_Hardware_Component_Model_Generic data type contains general information relating to a single SoftLayer generic component model. A generic component model represents a non-vendor specific representation of a hardware component. Frequently SoftLayer utilizes components from various vendors in the servers they provision. For Example: Several different vendors produce 6GB DDR2 memory. The generic component model for the 6GB stick of RAM encompasses every instance of this component regardless of make and model.
-
SoftLayer_Hardware_Component_Model_Generic_Attribute
The SoftLayer_Hardware_Component_Model_Generic_Attribute data type contains information relating to a single SoftLayer generic component model. Generic component model attributes can hold any information to describe functionality of the model. For Example: The number of cores that a processor has.
-
SoftLayer_Hardware_Component_Model_Generic_MarketingFeature
The SoftLayer_Hardware_Component_Model_Generic_MarketingFeature data type contains general information relating to all the advertising features of a single SoftLayer hardware generic component model.
-
SoftLayer_Hardware_Component_Motherboard
The SoftLayer_Hardware_Component_DriveController data type abstracts information related to a motherboard.
-
SoftLayer_Hardware_Component_Motherboard_Reboot_Time
The SoftLayer_Hardware_Component_Motherboard_Reboot_Time contains the average reboot times for motherboards. There are two types of average times. One is for motherboards without raid, and the other is for motherboards with raid. These times are based on averages and have been gathered through numerous test cases.
-
SoftLayer_Hardware_Component_NetworkCard
The SoftLayer_Hardware_Component_NetworkCard data type abstracts information related to a network card.
-
SoftLayer_Hardware_Component_Partition
The SoftLayer_Hardware_Component_Partition data type contains general information relating to a single hard drive partition.
-
SoftLayer_Hardware_Component_Partition_OperatingSystem
The SoftLayer_Hardware_Component_Partition_OperatingSystem data type contains general information relating to a single SoftLayer Operating System Partition Template.
-
SoftLayer_Hardware_Component_Partition_Template
The SoftLayer_Hardware_Component_Partition_Template data type contains general information relating to a single SoftLayer partition template. Partition templates group 1 or more partition configurations that can be used to predefine how a hard drive's partitions will be configured.
-
SoftLayer_Hardware_Component_Partition_Template_Partition
The SoftLayer_Hardware_Component_Partition_Template_Partition data type contains general information relating to a single SoftLayer Template Partition.
-
SoftLayer_Hardware_Component_Processor
The SoftLayer_Hardware_Component_Processor data type abstracts information related to a processor.
-
SoftLayer_Hardware_Component_PSID_Xref
The SoftLayer_Hardware_Component_PSID_Xref data type holds physical security ID information for hard drives
-
SoftLayer_Hardware_Component_Ram
The SoftLayer_Hardware_Component_Ram data type abstracts information related to RAM.
-
SoftLayer_Hardware_Component_RemoteManagement
This class adds functionality to the base SoftLayer_Hardware class for web servers (all server hardware)
-
SoftLayer_Hardware_Component_RemoteManagement_Command
The SoftLayer_Network_Storage_Evault_Version6 contains the names of the remote management commands. Currently, only the reboot and power commands for the remote management card exist.
-
SoftLayer_Hardware_Component_RemoteManagement_Command_Request
The SoftLayer_Hardware_Component_RemoteManagement_Command_Request contains details for remote management commands issued to a server's remote management card. Details for remote management commands such as powerOn, powerOff, powerCycle, rebootDefault, rebootSoft, rebootHard can be retrieved. Details such as the user who issued the command, the id of the remote management card the command was issued, when the command was issued may be retrieved.
-
SoftLayer_Hardware_Component_RemoteManagement_User
The credentials used for remote management such as username, password, etc...
-
SoftLayer_Hardware_Component_Revision
-
SoftLayer_Hardware_Component_SecurityDevice
The SoftLayer_Hardware_Component_SecurityDevice is used to determine the security devices attached to the hardware component.
-
SoftLayer_Hardware_Component_SecurityDevice_Infineon
The SoftLayer_Hardware_Component_SecurityDevice_Infineon is used to determine the Infineon security device attached to the hardware component.
-
SoftLayer_Hardware_Component_Type
The SoftLayer_Hardware_Component_Type data type provides details on the type of component requested
-
SoftLayer_Hardware_Firewall
The SoftLayer_Hardware_Firewall data type contains general information relating to a single SoftLayer firewall.
-
SoftLayer_Hardware_Function
The SoftLayer_Hardware_Function data type contains a generic object type for a piece of hardware, like switch, firewall, server, etc..
-
SoftLayer_Hardware_Group
-
SoftLayer_Hardware_LoadBalancer
-
SoftLayer_Hardware_Note
-
SoftLayer_Hardware_Note_Type
-
SoftLayer_Hardware_Power_Component
-
SoftLayer_Hardware_Resource_Configuration
-
SoftLayer_Hardware_Resource_Configuration_Property
-
SoftLayer_Hardware_Resource_Configuration_Property_Type
-
SoftLayer_Hardware_Resource_Configuration_Type
-
SoftLayer_Hardware_Router
The SoftLayer_Hardware_Router data type contains general information relating to a single SoftLayer router.
-
SoftLayer_Hardware_Router_Backend
The SoftLayer_Hardware_Router_Backend data type contains general information relating to a single SoftLayer router item for hardware.
-
SoftLayer_Hardware_Router_Frontend
The SoftLayer_Hardware_Router_Frontend data type contains general information relating to a single SoftLayer router item for hardware.
-
SoftLayer_Hardware_SecurityModule
-
SoftLayer_Hardware_SecurityModule750
-
SoftLayer_Hardware_Server
The SoftLayer_Hardware_Server data type contains general information relating to a single SoftLayer server.
-
SoftLayer_Hardware_Server_Partition
-
SoftLayer_Hardware_Server_Partition_Network_Attribute
-
SoftLayer_Hardware_State
The SoftLayer_Hardware_State type contains general information about the current state of it's associated hardware, including the current power state (i.e. Running or Stopped), and it's current transitioning state (e.g. Provisioning, Reloading).
-
SoftLayer_Hardware_Status
SoftLayer_Hardware_Status models the inventory state of any piece of hardware in SoftLayer's inventory. Most of these statuses are used by SoftLayer while a server is not provisioned or undergoing provisioning. SoftLayer uses the following status codes:
*'''ACTIVE''': This server is active and in use. *'''DEPLOY''': Used during server provisioning. *'''DEPLOY2''': Used during server provisioning. *'''MACWAIT''': Used during server provisioning. *'''RECLAIM''': This server has been reclaimed by SoftLayer and is awaiting de-provisioning.
Servers in production and in use should stay in the ACTIVE state. If a server's status ever reads anything else then please contact SoftLayer support.
-
SoftLayer_Hardware_Switch
The SoftLayer_Hardware_Switch object extends the base functionality of the SoftLayer_Hardware service.
-
SoftLayer_Layout_Container
The SoftLayer_Layout_Container contains definitions for default page layouts
-
SoftLayer_Layout_Container_Type
The SoftLayer_Layout_Container_Type contains definitions for container types
-
SoftLayer_Layout_Item
The SoftLayer_Layout_Item contains definitions for default layout items
-
SoftLayer_Layout_Item_Type
The SoftLayer_Layout_Item_Type contains definitions for item types
-
SoftLayer_Layout_Preference
The SoftLayer_Layout_Preference contains definitions for default layout item preferences
-
SoftLayer_Layout_Preference_Type
The SoftLayer_Layout_Preference_Type contains definitions for preference types
-
SoftLayer_Layout_Profile
The SoftLayer_Layout_Profile contains the definition of the layout profile
-
SoftLayer_Layout_Profile_Containers
-
SoftLayer_Layout_Profile_Customer
-
SoftLayer_Layout_Profile_Preference
The SoftLayer_Layout_Profile_Preference contains definitions for layout preferences
-
SoftLayer_Legal_RegulatedWorkload
-
SoftLayer_Legal_RegulatedWorkload_Type
-
SoftLayer_Locale
-
SoftLayer_Locale_Country
This service provides methods to retrieve country locale information.
-
SoftLayer_Locale_StateProvince
This object represents a state or province for a country.
-
SoftLayer_Locale_Timezone
Each User is assigned a timezone allowing for a precise local timestamp.
-
SoftLayer_Location
Every piece of hardware and network connection owned by SoftLayer is tracked physically by location and stored in the SoftLayer_Location data type. SoftLayer locations exist in parent/child relationships, a convenient way to track equipment from it's city, datacenter, server room, rack, then slot.
-
SoftLayer_Location_Datacenter
SoftLayer_Location_Datacenter extends the [SoftLayer_Location](/reference/datatypes/SoftLayer_Location) data type to include datacenter-specific properties.
-
SoftLayer_Location_Group
-
SoftLayer_Location_Group_Location_CrossReference
-
SoftLayer_Location_Group_Pricing
A pricing location group relates a set of [SoftLayer_Product_Item_Price](/reference/datatypes/SoftLayer_Product_Item_Price) to only be available to a set of [SoftLayer_Location](/reference/datatypes/SoftLayer_Location) when used for [SoftLayer_Product_Order](/reference/datatypes/SoftLayer_Product_Order).
-
SoftLayer_Location_Group_Regional
A regional location group is a collection of datacenters for a region.
-
SoftLayer_Location_Group_Type
-
SoftLayer_Location_Inventory_Room
SoftLayer_Location_Inventory_Room extends the [SoftLayer_Location](/reference/datatypes/SoftLayer_Location) data type to include inventory room-specific properties.
-
SoftLayer_Location_Network_Operations_Center
SoftLayer_Location_Network_Operations_Center extends the [SoftLayer_Location](/reference/datatypes/SoftLayer_Location) data type to include network operation center-specific properties.
-
SoftLayer_Location_Office
SoftLayer_Location_Office extends the [SoftLayer_Location](/reference/datatypes/SoftLayer_Location) data type to include office-specific properties.
-
SoftLayer_Location_Rack
SoftLayer_Location_Rack extends the [SoftLayer_Location](/reference/datatypes/SoftLayer_Location) data type to include rack-specific properties.
-
SoftLayer_Location_Region
A region is made up of a keyname and a description of that region. A region keyname can be used as part of an order. Check the SoftLayer_Product_Order service for more details.
-
SoftLayer_Location_Region_Location
The SoftLayer_Location_Region_Location is very specific to the location where services will actually be provisioned. When accessed through a package, this location is the top priority location for a region. All new servers and services are provisioned at this location. When a server is ordered and a region is selected, this is the location within that region where the server will actually exist and have software/services installed.
-
SoftLayer_Location_Reservation
-
SoftLayer_Location_Reservation_Rack
-
SoftLayer_Location_Reservation_Rack_Member
-
SoftLayer_Location_Root
SoftLayer_Location_Root extends the [SoftLayer_Location](/reference/datatypes/SoftLayer_Location) data type to include root-specific properties.
-
SoftLayer_Location_Server_Room
SoftLayer_Location_Server_Room extends the [SoftLayer_Location](/reference/datatypes/SoftLayer_Location) data type to include server room-specific properties.
-
SoftLayer_Location_Slot
SoftLayer_Location_Slot extends the [SoftLayer_Location](/reference/datatypes/SoftLayer_Location) data type to include slot-specific properties.
-
SoftLayer_Location_Status
SoftLayer_Location_Status models the state of any location. SoftLayer uses the following status codes:
*'''ACTIVE''': The location is currently active and available for public usage. *'''PLANNED''': Used when a location is planned but not yet active. *'''RETIRED''': Used when a location has been retired and no longer active.
Locations in use should stay in the ACTIVE state. If a locations status ever reads anything else and contains active hardware then please contact SoftLayer support.
-
SoftLayer_Location_Storage_Room
SoftLayer_Location_Storage_Room extends the [SoftLayer_Location](/reference/datatypes/SoftLayer_Location) data type to include storage room-specific properties.
-
SoftLayer_Marketplace_EmailDistribution
-
SoftLayer_Marketplace_Partner
-
SoftLayer_Marketplace_Partner_Attachment
-
SoftLayer_Marketplace_Partner_Attachment_Type
-
SoftLayer_Marketplace_Partner_File
-
SoftLayer_Marketplace_Partner_File_Attributes
-
SoftLayer_Metric_Tracking_Object
Metric tracking objects provides a common interface to all metrics provided by SoftLayer. These metrics range from network component traffic for a server to aggregated Bandwidth Pooling traffic and more. Every object within SoftLayer's range of objects that has data that can be tracked over time has an associated tracking object. Use the [SoftLayer_Metric_Tracking_Object](/reference/datatypes/SoftLayer_Metric_Tracking_Object) service to retrieve raw and graph data from a tracking object.
-
SoftLayer_Metric_Tracking_Object_Abstract
SoftLayer_Metric_Tracking_Object_Abstract models a generic tracking object type. Typically a tracking object with a specific purpose has it's own data type defined within the SoftLayer API.
-
SoftLayer_Metric_Tracking_Object_Bandwidth_Summary
This data type provides commonly used bandwidth summary components for the current billing cycle.
-
SoftLayer_Metric_Tracking_Object_Data
SoftLayer_Metric_Tracking_Object_Data models an individual unit of data tracked by a SoftLayer tracking object, including the type of data polled, the date it was polled at, and the counter value that was measured at polling time.
-
SoftLayer_Metric_Tracking_Object_HardwareServer
SoftLayer_Metric_Tracking_Object_HardwareServer models tracking objects specific to physical hardware and the data that are recorded by those servers.
-
SoftLayer_Metric_Tracking_Object_Type
SoftLayer [SoftLayer_Metric_Tracking_Object](/reference/datatypes/SoftLayer_Metric_Tracking_Object) can model various kinds of measured data, from server and virtual server bandwidth usage to CPU use to remote storage usage. SoftLayer_Metric_Tracking_Object_Type models one of these types and is referred to in tracking objects to reflect what type of data they track.
-
SoftLayer_Metric_Tracking_Object_Virtual_Storage_Repository
-
SoftLayer_Metric_Tracking_Object_VirtualDedicatedRack
SoftLayer_Metric_Tracking_Object_VirtualDedicatedRack models tracking objects specific to virtual dedicated racks. Bandwidth Pooling aggregate the bandwidth used by multiple servers within the rack.
-
SoftLayer_Monitoring_Robot
DEPRECATED. The SoftLayer_Monitoring_Robot data type contains general information relating to a monitoring robot.
-
SoftLayer_Monitoring_Robot_Status
DEPRECATED. Your monitoring robot will be in 'Active' status under normal circumstances. If you perform an OS reload, your robot will be in 'Reclaim' status until it's reloaded on your server or virtual server.
Advanced monitoring system requires 'Nimsoft Monitoring (Advanced)' service running and TCP ports 48000 - 48020 to be open on your server or virtual server. Monitoring agents cannot be managed nor can the usage data be updated if these ports are closed. Your monitoring robot will be in 'Limited Connectivity' status if our monitoring management system cannot communicate with your system.
See [SoftLayer_Monitoring_Robot::resetStatus](/reference/datatypes/$1/#$2) service for more details.
-
SoftLayer_Network
Provides services oriented to network-centric discovery and manipulation.
-
SoftLayer_Network_Application_Delivery_Controller
The SoftLayer_Network_Application_Delivery_Controller data type models a single instance of an application delivery controller. Local properties are read only, except for a ''notes'' property, which can be used to describe your application delivery controller service. The type's relational properties provide more information to the service's function and login information to the controller's backend management if advanced view is enabled.
-
SoftLayer_Network_Application_Delivery_Controller_Configuration_History
The SoftLayer_Network_Application_Delivery_Controller_Configuration_History data type models a single instance of a configuration history entry for an application delivery controller. The configuration history entries are used to support creating backups of an application delivery controller's configuration state in order to restore them later if needed.
-
SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute
-
SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute_Type
-
SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Check
-
SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Health_Check_Type
-
SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Routing_Method
-
SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Routing_Type
-
SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service
-
SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group
-
SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_Service_Group_CrossReference
-
SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress
-
SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress_SecureTransportCipher
A single cipher configured for a load balancer virtual IP address instance. Instances of this class are immutable and should reflect a cipher that is configurable on a load balancer device.
-
SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress_SecureTransportProtocol
Links a SSL transport protocol with a virtual IP address instance. Instances of this class are immutable and should reflect a protocol that is configurable on a load balancer device.
-
SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualServer
-
SoftLayer_Network_Application_Delivery_Controller_Type
-
SoftLayer_Network_Bandwidth_Usage
The SoftLayer_Network_Bandwidth_Usage data type contains specific information relating to bandwidth utilization at a specific point in time on a given network interface.
-
SoftLayer_Network_Bandwidth_Version1_Allocation
The SoftLayer_Network_Bandwidth_Version1_Allocation data type contains general information relating to a single bandwidth allocation record.
-
SoftLayer_Network_Bandwidth_Version1_Allotment
The SoftLayer_Network_Bandwidth_Version1_Allotment class provides methods and data structures necessary to work with an array of hardware objects associated with a single Bandwidth Pooling.
-
SoftLayer_Network_Bandwidth_Version1_Allotment_Detail
The SoftLayer_Network_Bandwidth_Version1_Allotment_Detail data type contains specific information relating to a single bandwidth allotment record.
-
SoftLayer_Network_Bandwidth_Version1_Allotment_Type
The SoftLayer_Network_Bandwidth_Version1_Allotment_Type contains a description of the associated SoftLayer_Network_Bandwidth_Version1_Allotment object.
-
SoftLayer_Network_Bandwidth_Version1_Usage_Detail
The SoftLayer_Network_Bandwidth_Version1_Usage_Detail data type contains specific information relating to bandwidth utilization at a specific point in time on a given network interface.
-
SoftLayer_Network_Bandwidth_Version1_Usage_Detail_Type
The SoftLayer_Network_Bandwidth_Version1_Usage_Detail_Type data type contains generic information relating to the types of bandwidth records available, currently just public and private.
-
SoftLayer_Network_CdnMarketplace_Account
The SoftLayer_Network_CdnMarketplace_Account data type models an individual CDN account. CDN accounts contain the SoftLayer account ID of the customer, the vendor ID the account belongs to, the customer ID provided by the vendor, and a CDN account's status.
-
SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking
-
SoftLayer_Network_CdnMarketplace_Configuration_Behavior_Geoblocking_Type
-
SoftLayer_Network_CdnMarketplace_Configuration_Behavior_HotlinkProtection
-
SoftLayer_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader
This service manages the modify response headers for domain mapping configurations.
-
SoftLayer_Network_CdnMarketplace_Configuration_Behavior_TokenAuth
This service manages the paths for domain mapping configurations.
-
SoftLayer_Network_CdnMarketplace_Configuration_Cache_Purge
This data type models a purge event that occurs in caching server. It contains a reference to a mapping configuration, the path to execute the purge on, the status of the purge, and flag that enables saving the purge information for future use.
-
SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeGroup
This data type models a purge group event that occurs in caching server. It contains a reference to a mapping configuration and the path to execute the purge on.
-
SoftLayer_Network_CdnMarketplace_Configuration_Cache_PurgeHistory
This data type models a purge history event that occurs in caching server. The purge group history will be deleted after 15 days. The possible purge status of each history can be 'SUCCESS', 'FAILED' or 'IN_PROGRESS'.
-
SoftLayer_Network_CdnMarketplace_Configuration_Cache_TimeToLive
This data type models a purge event that occurs repetitively and automatically in caching server after a set interval of time. A time to live instance contains a reference to a mapping configuration, the path to execute the purge on, the result of the purge, and the time interval after which the purge will be executed.
-
SoftLayer_Network_CdnMarketplace_Configuration_Mapping
This data type represents the mapping Configuration settings for enabling CDN services. Each instance contains a reference to a CDN account, and CDN configuration properties such as a domain, an origin host and its port, a cname we generate, a cname the vendor generates, and a status. Other properties include the type of content to be cached (static or dynamic), the origin type (a host server or an object storage account), and the protocol to be used for caching.
-
SoftLayer_Network_CdnMarketplace_Configuration_Mapping_Path
This service manages the paths for domain mapping configurations.
-
SoftLayer_Network_CdnMarketplace_Metrics
This Metrics class provides methods to get CDN metrics based on account or mapping unique id.
-
SoftLayer_Network_CdnMarketplace_Utils_Response
-
SoftLayer_Network_CdnMarketplace_Vendor
The SoftLayer_Network_CdnMarketplace_Vendor contains information regarding a CDN Vendor. This class is associated with SoftLayer_Network_CdnMarketplace_Vendor_Attribute class.
-
SoftLayer_Network_Component
Every piece of hardware running in SoftLayer's datacenters connected to the public, private, or management networks (where applicable) have a corresponding network component. These network components are modeled by the SoftLayer_Network_Component data type. These data types reflect the servers' local ethernet and remote management interfaces.
-
SoftLayer_Network_Component_Duplex_Mode
Duplex Mode allows finer grained control over networking options and settings.
-
SoftLayer_Network_Component_Firewall
The SoftLayer_Network_Component_Firewall data type contains general information relating to a single SoftLayer network component firewall. This is the object which ties the running rules to a specific downstream server. Use the [[SoftLayer Network Firewall Template]] service to pull SoftLayer recommended rule set templates. Use the [[SoftLayer Network Firewall Update Request]] service to submit a firewall update request.
-
SoftLayer_Network_Component_Firewall_Rule
A SoftLayer_Network_Component_Firewall_Rule object type represents a currently running firewall rule and contains relative information. Use the [[SoftLayer Network Firewall Update Request]] service to submit a firewall update request. Use the [[SoftLayer Network Firewall Template]] service to pull SoftLayer recommended rule set templates.
-
SoftLayer_Network_Component_Firewall_Subnets
A SoftLayer_Network_Component_Firewall_Subnets object type represents the current linked subnets and contains relative information. Use the [[SoftLayer Network Firewall Update Request]] service to submit a firewall update request. Use the [[SoftLayer Network Firewall Template]] service to pull SoftLayer recommended rule set templates.
-
SoftLayer_Network_Component_Group
-
SoftLayer_Network_Component_IpAddress
The SoftLayer_Network_Component_IpAddress data type contains general information relating to the binding of a single network component to a single SoftLayer IP address.
-
SoftLayer_Network_Component_Network_Vlan_Trunk
Represents the association between a Network_Component and Network_Vlan in the manner of a 'trunk'. Trunking a VLAN to a port allows that ports to receive and send packets tagged with the corresponding VLAN number.
-
SoftLayer_Network_Component_RemoteManagement
The SoftLayer_Network_Component_RemoteManagement data type contains general information relating to a single SoftLayer remote management network component.
-
SoftLayer_Network_Component_Uplink_Hardware
The SoftLayer_Network_Component_Uplink_Hardware data type abstracts information related to network connections between SoftLayer hardware and SoftLayer network components.
It is populated via triggers on the network_connection table (SoftLayer_Network_Connection), so you shouldn't have to delete or insert records into this table, ever.
-
SoftLayer_Network_Customer_Subnet
The SoftLayer_Network_Customer_Subnet data type contains general information relating to a single customer subnet (remote).
-
SoftLayer_Network_Customer_Subnet_IpAddress
The SoftLayer_Network_Customer_Subnet_IpAddress data type contains general information relating to a single Customer Subnet (Remote) IPv4 address.
-
SoftLayer_Network_DirectLink_Location
The SoftLayer_Network_DirectLink_Location presents a structure containing attributes of a Direct Link location, and its related object SoftLayer location.
-
SoftLayer_Network_DirectLink_Provider
The SoftLayer_Network_DirectLink_Provider presents a structure containing attributes of a Direct Link provider.
-
SoftLayer_Network_DirectLink_ServiceType
The SoftLayer_Network_DirectLink_ServiceType presents a structure containing attributes of a Direct Link Service Type.
-
SoftLayer_Network_Firewall_AccessControlList
The SoftLayer_Network_Firewall_AccessControlList data type contains general information relating to a single SoftLayer firewall access to controll list. This is the object which ties the running rules to a specific context. Use the [[SoftLayer Network Firewall Template]] service to pull SoftLayer recommended rule set templates. Use the [[SoftLayer Network Firewall Update Request]] service to submit a firewall update request.
-
SoftLayer_Network_Firewall_Interface
The SoftLayer_Network_Firewall_Interface data type contains general information relating to a single SoftLayer firewall interface. This is the object which ties the firewall context access control list to a firewall. Use the [[SoftLayer Network Firewall Template]] service to pull SoftLayer recommended rule set templates. Use the [[SoftLayer Network Firewall Update Request]] service to submit a firewall update request.
-
SoftLayer_Network_Firewall_Module_Context_Interface
-
SoftLayer_Network_Firewall_Template
The SoftLayer_Network_Firewall_Template type contains general information for a SoftLayer network firewall template.
Firewall templates are recommend rule sets for use with SoftLayer Hardware Firewall (Dedicated). These optimized templates are designed to balance security restriction with application availability. The templates given may be altered to provide custom network security, or may be used as-is for basic security. At least one rule set MUST be applied for the firewall to block traffic. Use the [[SoftLayer Network Component Firewall]] service to view current rules. Use the [[SoftLayer Network Firewall Update Request]] service to submit a firewall update request.
-
SoftLayer_Network_Firewall_Template_Rule
The SoftLayer_Network_Component_Firewall_Rule type contains general information relating to a single SoftLayer firewall template rule. Use the [[SoftLayer Network Component Firewall]] service to view current rules. Use the [[SoftLayer Network Firewall Update Request]] service to submit a firewall update request.
-
SoftLayer_Network_Firewall_Update_Request
The SoftLayer_Network_Firewall_Update_Request data type contains information relating to a SoftLayer network firewall update request. Use the [[SoftLayer Network Component Firewall]] service to view current rules. Use the [[SoftLayer Network Firewall Template]] service to pull SoftLayer recommended rule set templates.
-
SoftLayer_Network_Firewall_Update_Request_Customer
A SoftLayer_Ticket_Update_Customer is a single update made by a customer to a ticket.
-
SoftLayer_Network_Firewall_Update_Request_Employee
The SoftLayer_Network_Firewall_Update_Request_Employee data type returns a user object for the SoftLayer employee that created the request.
-
SoftLayer_Network_Firewall_Update_Request_Rule
The SoftLayer_Network_Firewall_Update_Request_Rule type contains information relating to a SoftLayer network firewall update request rule. This rule is a member of a [[SoftLayer Network Firewall Update Request]]. Use the [[SoftLayer Network Component Firewall]] service to view current rules. Use the [[SoftLayer Network Firewall Template]] service to pull SoftLayer recommended rule set templates.
-
SoftLayer_Network_Firewall_Update_Request_Rule_Version6
The SoftLayer_Network_Firewall_Update_Request_Rule_Version6 type contains information relating to a SoftLayer network firewall update request rule for IPv6. This rule is a member of a [[SoftLayer Network Firewall Update Request]]. Use the [[SoftLayer Network Component Firewall]] service to view current rules. Use the [[SoftLayer Network Firewall Template]] service to pull SoftLayer recommended rule set templates.
-
SoftLayer_Network_Gateway
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.
-
SoftLayer_Network_Gateway_Licenses
-
SoftLayer_Network_Gateway_Member
A network gateway member is a device that serves as a gateway. Once the hardware becomes a member of the gateway, only a reclaim can remove it. A reclaim on the last member of the gateway triggers a reclaim of the entire gateway.
-
SoftLayer_Network_Gateway_Member_Attribute
A network gateway member attribute is the attributes associated with a network gateway member.
-
SoftLayer_Network_Gateway_Member_Licenses
-
SoftLayer_Network_Gateway_Member_Passwords
-
SoftLayer_Network_Gateway_Precheck
A network gateway precheck is the precheck codes for member(s) of a gateway
-
SoftLayer_Network_Gateway_Status
A network gateway status is a value representing the state of a network gateway. The possible values are 'ACTIVE' for when the gateway is ready for normal use and 'UPDATING' for when the gateway is being updated.
-
SoftLayer_Network_Gateway_VersionUpgrade
A gateway software version upgrade reference provides pairing for possible upgrades from a given versin.
-
SoftLayer_Network_Gateway_Vlan
An inside VLAN is a VLAN which is attached to a network gateway and can be routed or bypassed.
-
SoftLayer_Network_Interconnect_Tenant
A network interconnect tenant defines an IP routing path through a network interconnect. Each network interconnect requires a single primary tenant, indicated by the primaryFlag
-
SoftLayer_Network_LBaaS_HealthMonitor
The SoftLayer_Network_LBaaS_HealthMonitor type presents a structure containing attributes of a health monitor object associated with load balancer instance. Note that the relationship between backend (pool) and health monitor is N-to-1, especially that the pools object associated with a health monitor must have the same pair of protocol and port. Example: frontend FA: http, 80 - backend BA: tcp, 3456 - healthmonitor HM_tcp3456 frontend FB: https, 443 - backend BB: tcp, 3456 - healthmonitor HM_tcp3456 In above example both backends BA and BB share the same healthmonitor HM_tcp3456
-
SoftLayer_Network_LBaaS_L7HealthMonitor
The SoftLayer_Network_LBaaS_L7HealthMonitor type presents a structure containing attributes of a health monitor object associated with a L7 pool instance. Note that the relationship between backend (L7 pool) and health monitor is 1-to-1, pools object associated with a health monitor must have the same pair of protocol and port. Example: frontend FA: http, 80 - backend BA: http, 3456 - healthmonitor HM_http3456 frontend FB: https, 443 - backend BB: http, 3456 - healthmonitor HM_http3456
-
SoftLayer_Network_LBaaS_L7Member
The SoftLayer_Network_LBaaS_L7Member represents the backend member for a L7 pool. It can be either a virtual server or a bare metal machine.
-
SoftLayer_Network_LBaaS_L7Policy
The SoftLayer_Network_LBaaS_L7Policy represents the policy for a listener.
-
SoftLayer_Network_LBaaS_L7Pool
The SoftLayer_Network_LBaaS_L7Pool type presents a structure containing attributes of a load balancer's L7 pool such as the protocol, and the load balancing algorithm used. L7 pool is used for redirect_pool action of the L7 policy and is different from the default pool
-
SoftLayer_Network_LBaaS_L7PoolMembersHealth
SoftLayer_Network_LBaaS_L7PoolMembersHealth provides statistics of members belonging to a particular L7 pool.
-
SoftLayer_Network_LBaaS_L7Rule
The SoftLayer_Network_LBaaS_L7Rule represents the Rules that can be attached to a a L7 policy.
-
SoftLayer_Network_LBaaS_L7SessionAffinity
SoftLayer_Network_LBaaS_L7SessionAffinity represents the session affinity, aka session persistence, configuration for a load balancer backend L7 pool.
-
SoftLayer_Network_LBaaS_Listener
The SoftLayer_Network_LBaaS_Listener type presents a data structure for a load balancers listener, also called frontend.
-
SoftLayer_Network_LBaaS_LoadBalancer
The SoftLayer_Network_LBaaS_LoadBalancer type presents a structure containing attributes of a load balancer, and its related objects including listeners, pools and members.
-
SoftLayer_Network_LBaaS_LoadBalancerAppliance
This class represents the load balancers appliances, ie virtual servers, on which the actual load balancer service is running. The relationship between load balancer and appliance is 1-to-N with N=2 for beta and very likely N=3 for post beta. Note that this class is for internal use only.
-
SoftLayer_Network_LBaaS_LoadBalancerHealthMonitorConfiguration
SoftLayer_Network_LBaaS_LoadBalancerHealthMonitorConfiguration specifies the check method to be used for health monitoring backend members.
-
SoftLayer_Network_LBaaS_LoadBalancerMonitoringMetricDataPoint
SoftLayer_Network_LBaaS_LoadBalancerMonitoringMetricDataPoint is a collection of datapoints retrieved from a load balancer instance. The available metrics are: <ul> <li>The metric value </li> <li>The timestamp when the metric value was obtained </li> </ul>
-
SoftLayer_Network_LBaaS_LoadBalancerProtocolConfiguration
SoftLayer_Network_LBaaS_LoadBalancerProtocolConfiguration specifies the protocol, port, maximum number of allowed connections and session stickiness for load balancer's front- and backend.
-
SoftLayer_Network_LBaaS_LoadBalancerServerInstanceInfo
SoftLayer_Network_LBaaS_LoadBalancerServerInstanceInfo specifies the application server, usually an IBM SoftLayer virtual server or bare metal system, to be assigned to a load balancer.
-
SoftLayer_Network_LBaaS_LoadBalancerStatistics
SoftLayer_Network_LBaaS_LoadBalancerStatistics is a collection of metrics retrieved from a load balancer instance. The available metrics are: <ul> <li>NUmber of members up</li> <li>Number of members down</li> <li>Total number of active connections</li> <li>Throughput</li> <li>Data processed by month</li> <li>Connection rate</li> </ul>
-
SoftLayer_Network_LBaaS_Member
The SoftLayer_Network_LBaaS_Member represents the backend member for a load balancer. It can be either a virtual server or a bare metal machine.
-
SoftLayer_Network_LBaaS_MemberHealth
SoftLayer_Network_LBaaS_MemberHealth is a collection member metrics retrieved from a LBaaS VSI instance. The available metrics are: <ul> <li>Name of the member</li> <li>Status of the member up or down</li> <li>Uuid of the member</li> </ul>
-
SoftLayer_Network_LBaaS_PolicyRule
SoftLayer_Network_LBaaS_PolicyRule
This class contains layer 7 policy specifications and an array of associated rules An array of objects of this class must be passed to the API in order to create a policy and its associated rules. <ul> <li>The layer 7 policy object </li> <li>An array of layer 7 rules </li> </ul>
-
SoftLayer_Network_LBaaS_Pool
The SoftLayer_Network_LBaaS_Pool type presents a structure containing attributes of a load balancer pool such as the protocol, protocol port and the load balancing algorithm used.
-
SoftLayer_Network_LBaaS_PoolMembersHealth
SoftLayer_Network_LBaaS_PoolMembersHealth provides statistics of members belonging to a particular pool.
-
SoftLayer_Network_LBaaS_SessionAffinity
SoftLayer_Network_LBaaS_SessionAffinity represents the session affinity, aka session persistence, configuration for a load balancer backend pool.
-
SoftLayer_Network_LBaaS_SSLCipher
The SoftLayer_Network_LBaaS_SSLCipher type presents a structure that contains attributes of load balancer cipher suites.
-
SoftLayer_Network_LoadBalancer_Service
The SoftLayer_Network_LoadBalancer_Service data type contains all the information relating to a specific service (destination) on a particular load balancer.
Information retained on the object itself is the the source and destination of the service, routing type, weight, and whether or not the service is currently enabled.
-
SoftLayer_Network_LoadBalancer_VirtualIpAddress
The SoftLayer_Network_LoadBalancer_VirtualIpAddress data type contains all the information relating to a specific load balancer assigned to a customer account.
Information retained on the object itself is the virtual IP address, load balancing method, and any notes that are related to the load balancer. There is also an array of SoftLayer_Network_LoadBalancer_Service objects, which represent the load balancer services, explained more fully in the SoftLayer_Network_LoadBalancer_Service documentation.
-
SoftLayer_Network_Logging_Syslog
The Syslog class holds a single line from the Networking Firewall 'Syslog' record, for firewall detected and blocked attempts on a server.
-
SoftLayer_Network_Message_Delivery
-
SoftLayer_Network_Message_Delivery_Attribute
-
SoftLayer_Network_Message_Delivery_Email_Sendgrid
-
SoftLayer_Network_Message_Delivery_Type
-
SoftLayer_Network_Message_Delivery_Vendor
-
SoftLayer_Network_Monitor
-
SoftLayer_Network_Monitor_Version1_Incident
The SoftLayer_Network_Monitor_Version1_Incident data type models a single virtual server or physical hardware network monitoring event. SoftLayer_Network_Monitor_Version1_Incidents are created when the SoftLayer monitoring system detects a service down on your hardware of virtual server. As the incident is resolved it's status changes from 'SERVICE FAILURE' to 'COMPLETED'.
-
SoftLayer_Network_Monitor_Version1_Query_Host
The Monitoring_Query_Host type represents a monitoring instance. It consists of a hardware ID to monitor, an IP address attached to that hardware ID, a method of monitoring, and what to do in the instance that the monitor ever fails.
-
SoftLayer_Network_Monitor_Version1_Query_Host_Stratum
The monitoring stratum type stores the maximum level of the various components of the monitoring system that a particular hardware object has access to. This object cannot be accessed by ID, and cannot be modified. The user can access this object through Hardware_Server->availableMonitoring.
There are two values on this object that are important: # monitorLevel determines the highest level of SoftLayer_Network_Monitor_Version1_Query_Type object that can be placed in a monitoring instance on this server # responseLevel determines the highest level of SoftLayer_Network_Monitor_Version1_Query_ResponseType object that can be placed in a monitoring instance on this server
Also note that the query type and response types are available through getAllQueryTypes and getAllResponseTypes, respectively.
-
SoftLayer_Network_Monitor_Version1_Query_ResponseType
The ResponseType type stores only an ID and a description of the response type. The only use for this object is in reference. The user chooses a response action that would be appropriate for a monitoring instance, and sets the ResponseTypeId to the SoftLayer_Network_Monitor_Version1_Query_Host->responseActionId value.
The user can retrieve all available ResponseTypes with the getAllObjects method on this service.
-
SoftLayer_Network_Monitor_Version1_Query_Result
The monitoring result object is used to show the status of the actions taken by the monitoring system.
In general, only the responseStatus variable is needed, as it holds the information on the status of the service.
-
SoftLayer_Network_Monitor_Version1_Query_Type
The MonitorType type stores a name, long description, and default arguments for the monitor types. The only use for this object is in reference. The user chooses a monitoring type that would be appropriate for their server, and sets the id of the Query_Type to SoftLayer_Network_Monitor_Version1_Query_Host->queryTypeId
The user can retrieve all available Query Types with the getAllObjects method on this service.
-
SoftLayer_Network_Pod
SoftLayer_Network_Pod refers to a portion of a data center that share a Backend Customer Router (BCR) and usually a front-end counterpart known as a Frontend Customer Router (FCR). A Pod primarily denotes a logical location within the network and the physical aspects that support networks. This is in contrast to representing a specific physical location.
A ``Pod`` is identified by a ``name``, which is unique. A Pod name follows the format 'dddnn.podii', where 'ddd' is a data center code, 'nn' is the data center number, 'pod' is a literal string and 'ii' is a two digit, left-zero- padded number which corresponds to a Backend Customer Router (BCR) of the desired data center. Examples: <ul> <li>dal09.pod01 = Dallas 9, Pod 1 (ie. bcr01)</li> <li>sng01.pod02 = Singapore 1, Pod 2 (ie. bcr02)</li> <li>par01.pod01 = Paris 1, Pod 1 (ie. bcr01)</li> </ul>
-
SoftLayer_Network_Protection_Address
-
SoftLayer_Network_Regional_Internet_Registry
Regional Internet Registries are the organizations who delegate IP address blocks to other groups or organizations around the Internet. The information contained in this data type is used throughout the networking-related services in our systems.
-
SoftLayer_Network_Security_Scanner_Request
The SoftLayer_Network_Security_Scanner_Request data type represents a single vulnerability scan request. It provides information on when the scan was created, last updated, and the current status. The status messages are as follows: *Scan Pending *Scan Processing *Scan Complete *Scan Cancelled *Generating Report.
-
SoftLayer_Network_Security_Scanner_Request_Status
The SoftLayer_Network_Security_Scanner_Request_Status data type represents the current status of a vulnerability scan. The status messages are as follows: *Scan Pending *Scan Processing *Scan Complete *Scan Cancelled *Generating Report.
The status of a vulnerability scan will change over the course of a scan's execution.
-
SoftLayer_Network_SecurityGroup
The SoftLayer_Network_SecurityGroup data type contains general information for a single security group. A security group contains a set of IP filter [SoftLayer_Network_SecurityGroup_Rule](/reference/datatypes/SoftLayer_Network_SecurityGroup_Rule) that define how to handle incoming (ingress) and outgoing (egress) traffic to both the public and private interfaces of a virtual server instance and a set of [SoftLayer_Virtual_Network_SecurityGroup_NetworkComponentBinding](/reference/datatypes/SoftLayer_Virtual_Network_SecurityGroup_NetworkComponentBinding) to associate virtual guest network components with the security group.
-
SoftLayer_Network_SecurityGroup_OrderBinding
The SoftLayer_Network_SecurityGroup_OrderBinding data type contains links between security groups and product orders.
-
SoftLayer_Network_SecurityGroup_Request
The SoftLayer_Network_SecurityGroup_Request data type contains the ID of a specific request sent to the API. This ID is used to identify specific calls to attach and detach network components, as well as add, edit, and remove security group rules.
-
SoftLayer_Network_SecurityGroup_RequestRules
The SoftLayer_Network_SecurityGroup_RequestRules data type contains the ID of a specific request sent to the API, as well as an associative array of the rules that were created, edited, or removed by the request.
-
SoftLayer_Network_SecurityGroup_Rule
The SoftLayer_Network_SecurityGroup_Rule data type contains general information for a single rule that belongs to a [SoftLayer_Network_SecurityGroup](/reference/datatypes/SoftLayer_Network_SecurityGroup). By default, all traffic (both inbound and
outbound) to a virtual server instance is blocked. Security group rules are permissive, and define the allowed incoming (ingress) and outgoing (egress) traffic to both the public and private interfaces of a
virtual server instance. The order of rules within a security group does not matter and priority always falls to the least restrictive rule.
-
SoftLayer_Network_Service_Resource
The SoftLayer_Network_Service_Resource is used to store information related to a service. It is used for determining the correct resource to connect to for a given service, like NAS, Evault, etc.
-
SoftLayer_Network_Service_Resource_Attribute
-
SoftLayer_Network_Service_Resource_Attribute_Type
-
SoftLayer_Network_Service_Resource_CosStor
The SoftLayer_Network_Service_Resource_CosStor is used to store information related to COS service.
-
SoftLayer_Network_Service_Resource_Hub
-
SoftLayer_Network_Service_Resource_Hub_Swift
-
SoftLayer_Network_Service_Resource_Type
-
SoftLayer_Network_Service_Vpn_Overrides
The SoftLayer_Network_Service_Vpn_Overrides data type contains information relating user ids to subnet ids when VPN access is manually configured. It is essentially an entry in a 'white list' of subnets a SoftLayer portal VPN user may access.
-
SoftLayer_Network_Storage
The SoftLayer_Network_Storage data type contains general information regarding a Storage product such as account id, access username and password, the Storage product type, and the server the Storage service is associated with. Currently, only EVault backup storage has an associated server.
-
SoftLayer_Network_Storage_Allowed_Host
-
SoftLayer_Network_Storage_Allowed_Host_Hardware
-
SoftLayer_Network_Storage_Allowed_Host_IpAddress
-
SoftLayer_Network_Storage_Allowed_Host_Subnet
-
SoftLayer_Network_Storage_Allowed_Host_VirtualGuest
-
SoftLayer_Network_Storage_Backup
The SoftLayer_Network_Storage_Backup contains general information regarding a Storage backup service such as account id, username, maximum capacity, password, Storage's product type and the server id.
-
SoftLayer_Network_Storage_Backup_Evault
The SoftLayer_Network_Storage_Backup_Evault contains general information regarding an EVault Storage service such as account id, username, maximum capacity, password, Storage's product type and the server id.
-
SoftLayer_Network_Storage_Backup_Evault_Version6
The SoftLayer_Network_Storage_Backup_Evault_Version6 contains the same properties as the SoftLayer_Network_Storage_Backup_Evault. Additional properties available for the EVault Storage type: softwareComponent, totalBytesUsed, backupJobDetails, restoreJobDetails and agentStatuses
-
SoftLayer_Network_Storage_Credential
The SoftLayer_Network_Storage_Credential data type will give you an overview of the usernames that are currently attached to your storage device.
-
SoftLayer_Network_Storage_Credential_Type
<<<
-
SoftLayer_Network_Storage_Daily_Usage
-
SoftLayer_Network_Storage_DedicatedCluster
-
SoftLayer_Network_Storage_Event
Storage volumes can create various events to keep track of what has occurred to the volume. Events provide an audit trail that can be used to verify that various tasks have occurred, such as snapshots to be created by a schedule or remote replication synchronization.
-
SoftLayer_Network_Storage_Event_Type
-
SoftLayer_Network_Storage_Group
-
SoftLayer_Network_Storage_Group_Iscsi
-
SoftLayer_Network_Storage_Group_Nfs
-
SoftLayer_Network_Storage_Group_Type
-
SoftLayer_Network_Storage_History
The SoftLayer_Network_Storage_History contains the username/password past history for Storage services except Evault. Information such as the username, passwords, notes and the date of the password change may be retrieved.
-
SoftLayer_Network_Storage_Hub
The SoftLayer_Network_Storage_Hub data type models Virtual Server type Storage storage offerings.
-
SoftLayer_Network_Storage_Hub_Cleversafe_Account
This class provides an interface for the management of IBM Cloud Object Storage Accounts and Credentials.
-
SoftLayer_Network_Storage_Hub_Swift
-
SoftLayer_Network_Storage_Hub_Swift_Container
-
SoftLayer_Network_Storage_Hub_Swift_Metrics
This service provides summarization functionality for Swift based accounts. It uses influxDB as a backend
-
SoftLayer_Network_Storage_Hub_Swift_Share
-
SoftLayer_Network_Storage_Hub_Swift_Version1
-
SoftLayer_Network_Storage_Iscsi
The iscsi data type provides access to additional information about an iscsi volume such as the snapshot capacity limit and replication partners.
-
SoftLayer_Network_Storage_Iscsi_OS_Type
-
SoftLayer_Network_Storage_MassDataMigration_CrossRegion_Country_Xref
MassDataMigration_CrossRegion_Country_Xref provides a list of countries where Mass Data Migration Device could be shipped for each CleverSafe Object Storage Region.
-
SoftLayer_Network_Storage_MassDataMigration_Request
The SoftLayer_Network_Storage_MassDataMigration_Request data type contains information on a single Mass Data Migration request. Creation of these requests is limited to SoftLayer customers through the SoftLayer Customer Portal.
-
SoftLayer_Network_Storage_MassDataMigration_Request_DeviceConfiguration
The SoftLayer_Network_Storage_MassDataMigration_Request_DeviceConfiguration data type contains settings such networking, COS account, which needs to be configured on device for a Mass Data Migration Request.
-
SoftLayer_Network_Storage_MassDataMigration_Request_KeyContact
The SoftLayer_Network_Storage_MassDataMigration_Request_KeyContact data type contains name, email, and phone for key contact at customer location who will handle Mass Data Migration.
-
SoftLayer_Network_Storage_MassDataMigration_Request_Status
The SoftLayer_Network_Storage_MassDataMigration_Request_Status data type contains general information relating to the statuses to which a Mass Data Migration Request may be set.
-
SoftLayer_Network_Storage_Nas
The SoftLayer_Network_Storage_Nas contains general information regarding a NAS Storage service such as account id, username, password, maximum capacity, Storage's product type and capacity.
-
SoftLayer_Network_Storage_Partnership
A network storage partnership is used to link multiple volumes to each other. These partnerships describe replication hierarchies or link volume snapshots to their associated storage volume.
-
SoftLayer_Network_Storage_Partnership_Type
A network storage partnership type is used to define the link between two volumes.
-
SoftLayer_Network_Storage_Property
A property provides additional information about a volume which it is assigned to. This information can range from 'Mountable' flags to utilized snapshot space.
-
SoftLayer_Network_Storage_Property_Type
The storage property types provide standard definitions for properties which can be used with any type for Storage offering. The properties provide additional information about a volume which they are assigned to.
-
SoftLayer_Network_Storage_Replicant
-
SoftLayer_Network_Storage_Schedule
Schedules can be created for select Storage services, such as iscsi. These schedules are used to perform various tasks such as scheduling snapshots or synchronizing replicants.
-
SoftLayer_Network_Storage_Schedule_Property
Schedule properties provide attributes such as start date, end date, interval, and other properties to a storage schedule.
-
SoftLayer_Network_Storage_Schedule_Property_Type
A schedule property type is used to allow for a standardized method of defining network storage schedules.
-
SoftLayer_Network_Storage_Schedule_Type
A schedule type is used to define what a schedule was created to do. When creating a schedule to take snapshots of a volume, the 'Snapshot' schedule type would be used.
-
SoftLayer_Network_Storage_Snapshot
-
SoftLayer_Network_Storage_Type
The SoftLayer_Network_Storage_Type contains a description of the associated SoftLayer_Network_Storage object.
-
SoftLayer_Network_Subnet
A subnet represents a continguous range of IP addresses. The range is represented by the networkIdentifer and cidr/netmask properties. The version of a subnet, whether IPv4 or IPv6, is represented by the version property.
When routed, a subnet is associated to a VLAN on your account, which defines its scope on the network. Depending on a subnet's route type, IP addresses may be reserved for network and internal functions, the most common of which is the allocation of network, gateway and broadcast IP addresses.
An unrouted subnet is not active on the network and may generally be routed within the datacenter in which it resides.
[Subnetwork at Wikipedia](http://en.wikipedia.org/wiki/Subnetwork)
[RFC950:Internet Standard Subnetting Procedure](http://datatracker.ietf.org/doc/html/rfc950)
-
SoftLayer_Network_Subnet_IpAddress
The SoftLayer_Network_Subnet_IpAddress data type contains general information relating to a single SoftLayer IPv4 address.
-
SoftLayer_Network_Subnet_IpAddress_Global
Global IP Addresses are static IP addresses that can be routed to any server within the SoftLayer network. Global IP Addresses are not restricted to routing within the same datacenter.
-
SoftLayer_Network_Subnet_IpAddress_UsageDetail
Describes an IP address assigned to a resource on your network.
Details on the associated resource are also provided, described below. Details include the resource's type, unique identifier, name, fully qualified name, and context, the contents of which depends on the resource's type. If the fully qualified name is not included for a resource type below, the resource's name will apply.
The following resource types and associated dependent properties are supported:
* <b>HARDWARE</b>: A [Bare Metal Server](/reference/datatypes/SoftLayer_Hardware_Server)
-- <i>resourceName</i>: The hostname of the server.
-- <i>resourceFullyQualifiedName</i>: The fully qualified domain name of the server.
-- <i>resourceContext</i>: The name of the network component or network component group assigned to the IP address, <i>e.g. eth0/2</i>.
* <b>GUEST</b>: A [Virtual Server Instance](/reference/datatypes/SoftLayer_Virtual_Guest)
-- <i>resourceName</i>: The hostname of the guest.
-- <i>resourceFullyQualifiedName</i>: The fully qualified domain name of the guest.
-- <i>resourceContext</i>: The name of the virtual network component assigned to the IP address, <i>e.g. eth0</i>.
* <b>GATEWAY</b>: A [Network Gateway](/reference/datatypes/SoftLayer_Network_Gateway)
-- <i>resourceName</i>: The name of the gateway.
-- <i>resourceContext</i>: Either the term 'virtual' to indicate a gateway IP address, or the name of the network component or network component group assigned to the IP address followed by the id-value of the [Bare Metal Server](/reference/datatypes/SoftLayer_Hardware_Server) gateway member surrounded by '<', '>', <i>e.g. eth1/3<123456></i>.
- <b>FIREWALL_MULTIVLAN</b>: A [Multi-VLAN Firewall](/reference/datatypes/SoftLayer_Network_Vlan_Firewall)
-- <i>resourceName</i>: The name of the firewall.
-- <i>resourceContext</i>: The term 'virtual' to indicate a firewall IP address.
- <b>LBAAS</b>: A [Cloud Load Balancer](/reference/datatypes/SoftLayer_Network_LBaaS_LoadBalancer)
-- <i>resourceName</i>: The name of the load balancer.
-- <i>resourceFullyQualifiedName</i>: The full DNS address of the load balancer.
-- <i>resourceContext</i>: The term 'ephemeral' to indicate a currently assigned IP address, subject to change. Users are strongly encouraged to access the service by the fully qualified DNS name and not the underlying IP addresses. The UUID of the load balancer is also provided, surrounded by '<' and '>', e.g. ephemeral<84f0affb-0d5e-40f1-ad87-a92d6544936a>
- <b>NETSCALER_VPX</b>: A [Netscaler VPX Load Balancer](/reference/datatypes/SoftLayer_Network_Application_Delivery_Controller)
-- <i>resourceName</i>: The hostname of the load balancer.
-- <i>resourceFullyQualifiedName</i>: The fully qualified domain name of the load balancer.
-- <i>resourceContext</i>: Either the term 'nsip' to indicate the management IP address, or the name of the network component assigned to the IP address followed by the id-value of the [Virtual Server Instance](/reference/datatypes/SoftLayer_Virtual_Guest) load balancer host surrounded by '<', '>', <i>e.g. eth1<123456></i>.
- <b>NETSCALER_MPX</b>: A [Netscaler MPX Load Balancer](/reference/datatypes/SoftLayer_Hardware_LoadBalancer)
-- <i>resourceName</i>: The hostname of the load balancer.
-- <i>resourceFullyQualifiedName</i>: The fully qualified domain name of the load balancer.
-- <i>resourceContext</i>: The name of the network component or network component group assigned to the IP address, <i>e.g. eth0/2</i>.
-
SoftLayer_Network_Subnet_IpAddress_Version6
The SoftLayer_Network_Subnet_IpAddress data type contains general information relating to a single SoftLayer IPv6 address.
-
SoftLayer_Network_Subnet_Registration
The subnet registration service has been deprecated.
The subnet registration data type contains general information relating to a single subnet registration instance. These registration instances can be updated to reflect changes, and will record the changes in the [SoftLayer_Network_Subnet_Registration_Event](/reference/datatypes/SoftLayer_Network_Subnet_Registration_Event).
-
SoftLayer_Network_Subnet_Registration_Apnic
The APNIC subnet registration type has been deprecated.
APNIC-specific registration object. For more detail see [SoftLayer_Network_Subnet_Registration](/reference/datatypes/SoftLayer_Network_Subnet_Registration).
-
SoftLayer_Network_Subnet_Registration_Arin
The ARIN subnet registration type has been deprecated.
ARIN-specific registration object. For more detail see [SoftLayer_Network_Subnet_Registration](/reference/datatypes/SoftLayer_Network_Subnet_Registration).
-
SoftLayer_Network_Subnet_Registration_Details
The subnet registration details type has been deprecated.
The SoftLayer_Network_Subnet_Registration_Details objects are used to relate [SoftLayer_Account_Regional_Registry_Detail](/reference/datatypes/SoftLayer_Account_Regional_Registry_Detail) objects to a [SoftLayer_Network_Subnet_Registration](/reference/datatypes/SoftLayer_Network_Subnet_Registration) object. This allows for easy reuse of registration details. It is important to note that only one detail object per type may be associated to a registration object.
-
SoftLayer_Network_Subnet_Registration_Event
The subnet registration event type has been deprecated.
Each time a [SoftLayer_Network_Subnet_Registration](/reference/datatypes/SoftLayer_Network_Subnet_Registration) object is created or modified, the system will generate an event for it. Additional actions that would create an event include RIR responses and error cases. *
-
SoftLayer_Network_Subnet_Registration_Event_Type
The subnet registration event type type has been deprecated.
Subnet Registration Event Type objects describe the nature of a [SoftLayer_Network_Subnet_Registration_Event](/reference/datatypes/SoftLayer_Network_Subnet_Registration_Event)
The standard values for these objects are as follows: <ul> <li><strong>REGISTRATION_CREATED</strong> - Indicates that the registration has been created</li> <li><strong>REGISTRATION_UPDATED</strong> - Indicates that the registration has been updated</li> <li><strong>REGISTRATION_CANCELLED</strong> - Indicates that the registration has been cancelled</li> <li><strong>RIR_RESPONSE</strong> - Indicates that an action taken against the RIR has produced a response. More details will be provided in the event message.</li> <li><strong>ERROR</strong> - Indicates that an error has been encountered. More details will be provided in the event message.</li> <li><strong>NOTE</strong> - An employee or other system has entered a note regarding the registration. The note content will be provided in the event message.</li> </ul>
-
SoftLayer_Network_Subnet_Registration_Ripe
The RIPE subnet registration type has been deprecated.
RIPE-specific registration object. For more detail see [SoftLayer_Network_Subnet_Registration](/reference/datatypes/SoftLayer_Network_Subnet_Registration).
-
SoftLayer_Network_Subnet_Registration_Status
The subnet registration status type has been deprecated.
Subnet Registration Status objects describe the current status of a subnet registration.
The standard values for these objects are as follows: <ul> <li><strong>OPEN</strong> - Indicates that the registration object is new and has yet to be submitted to the RIR</li> <li><strong>PENDING</strong> - Indicates that the registration object has been submitted to the RIR and is awaiting response</li> <li><strong>COMPLETE</strong> - Indicates that the RIR action has completed</li> <li><strong>DELETED</strong> - Indicates that the registration object has been gracefully removed is no longer valid</li> <li><strong>CANCELLED</strong> - Indicates that the registration object has been abruptly removed is no longer valid</li> </ul>
-
SoftLayer_Network_Subnet_Rwhois_Data
Every SoftLayer customer account has contact information associated with it for reverse WHOIS purposes. An account's RWHOIS data, modeled by the SoftLayer_Network_Subnet_Rwhois_Data data type, is used by SoftLayer's reverse WHOIS server as well as for SWIP transactions. SoftLayer's reverse WHOIS servers respond to WHOIS queries for IP addresses belonging to a customer's servers, returning this RWHOIS data.
A SoftLayer customer's RWHOIS data may not necessarily match their account or portal users' contact information.
-
SoftLayer_Network_Subnet_Swip_Transaction
**DEPRECATED** The SoftLayer_Network_Subnet_Swip_Transaction data type contains basic information tracked at SoftLayer to allow automation of Swip creation, update, and removal requests. A specific transaction is attached to an accountId and a subnetId. This also contains a 'Status Name' which tells the customer what the transaction is doing:
* REQUEST QUEUED: Request is queued up to be sent to ARIN * REQUEST SENT: The email request has been sent to ARIN * REQUEST CONFIRMED: ARIN has confirmed that the request is good, and should be available in 24 hours * OK: The subnet has been checked with WHOIS and it the SWIP transaction has completed correctly * REMOVE QUEUED: A subnet is queued to be removed from ARIN's systems * REMOVE SENT: The removal email request has been sent to ARIN * REMOVE CONFIRMED: ARIN has confirmed that the removal request is good, and the subnet should be clear in WHOIS in 24 hours * DELETED: This specific SWIP Transaction has been removed from ARIN and is no longer in effect * SOFTLAYER MANUALLY PROCESSING: Sometimes a request doesn't go through correctly and has to be manually processed by SoftLayer. This may take some time.
-
SoftLayer_Network_Tunnel_Module_Context
The SoftLayer_Network_Tunnel_Module_Context data type contains general information relating to a single SoftLayer network tunnel. The SoftLayer_Network_Tunnel_Module_Context is useful to gather information such as related customer subnets (remote) and internal subnets (local) associated with the network tunnel as well as other information needed to manage the network tunnel. Account and billing information related to the network tunnel can also be retrieved.
-
SoftLayer_Network_Tunnel_Module_Context_Address_Translation
The SoftLayer_Network_Tunnel_Module_Context_Address_Translation data type contains general information relating to a single address translation. Information such as notes, ip addresses, along with record information, and network tunnel data may be retrieved.
-
SoftLayer_Network_Vlan
VLANs comprise the fundamental segmentation model on the network, isolating customer networks from one another.
VLANs are scoped to a single network, generally public or private, and a pod. Through association to a single VLAN, assigned subnets are routed on the network to provide IP address connectivity.
Compute devices are associated to a single VLAN per active network, to which the Primary IP Address and containing Primary Subnet belongs. Additional VLANs may be associated to bare metal devices using VLAN trunking.
[VLAN at Wikipedia](https://en.wikipedia.org/wiki/VLAN)
-
SoftLayer_Network_Vlan_Firewall
The SoftLayer_Network_Vlan_Firewall data type contains general information relating to a single SoftLayer VLAN firewall. This is the object which ties the running rules to a specific downstream server. Use the [[SoftLayer Network Firewall Template]] service to pull SoftLayer recommended rule set templates. Use the [[SoftLayer Network Firewall Update Request]] service to submit a firewall update request.
-
SoftLayer_Network_Vlan_Firewall_Rule
A SoftLayer_Network_Component_Firewall_Rule object type represents a currently running firewall rule and contains relative information. Use the [[SoftLayer Network Firewall Update Request]] service to submit a firewall update request. Use the [[SoftLayer Network Firewall Template]] service to pull SoftLayer recommended rule set templates.
-
SoftLayer_Network_Vlan_Type
A network VLAN type is a value representing the type of a network VLAN. The possible values are:
* STANDARD - A VLAN for normal server or guest use * GATEWAY - A VLAN designated for use as a network gateway VLAN
-
SoftLayer_Notification
Details provided for the notification are basic. Details such as the related preferences, name and keyname for the notification can be retrieved. The keyname property for the notification can be used to refer to a notification when integrating into the SoftLayer Notification system. The name property can used more for display purposes.
-
SoftLayer_Notification_Delivery_Method
Provides details for the delivery methods available.
-
SoftLayer_Notification_Mobile
This is an extension of the SoftLayer_Notification class. These are implementation details specific to those notifications which can be subscribed to and received on a mobile device.
-
SoftLayer_Notification_Occurrence_Account
-
SoftLayer_Notification_Occurrence_Event
The [SoftLayer_Notification_Occurrence_Event](/reference/datatypes/SoftLayer_Notification_Occurrence_Event) service represents all events with potential to cause a disruption in service.
-
SoftLayer_Notification_Occurrence_Event_Attachment
SoftLayer events can have have files attached to them by a SoftLayer employee. Attaching a file to a event is a way to provide supplementary information such as a RFO (reason for outage) document or root cause analysis. The SoftLayer_Notification_Occurrence_Event_Attachment data type models a single file attached to a event.
-
SoftLayer_Notification_Occurrence_Event_Type
This represents the type of SoftLayer_Notification_Occurrence_Event.
-
SoftLayer_Notification_Occurrence_Resource
This type contains general information relating to any hardware or services that may be impacted by a SoftLayer_Notification_Occurrence_Event.
-
SoftLayer_Notification_Occurrence_Resource_Hardware
This type contains general information related to a [SoftLayer_Hardware](/reference/datatypes/SoftLayer_Hardware) resource that is impacted by a [SoftLayer_Notification_Occurrence_Event](/reference/datatypes/SoftLayer_Notification_Occurrence_Event).
-
SoftLayer_Notification_Occurrence_Resource_Network_Application_Delivery_Controller
This type contains general information related to a [SoftLayer_Network_Application_Delivery_Controller](/reference/datatypes/SoftLayer_Network_Application_Delivery_Controller) resource that is impacted by a [SoftLayer_Notification_Occurrence_Event](/reference/datatypes/SoftLayer_Notification_Occurrence_Event).
-
SoftLayer_Notification_Occurrence_Resource_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress
This type contains general information related to a [SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress](/reference/datatypes/SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress) resource that is impacted by a [SoftLayer_Notification_Occurrence_Event](/reference/datatypes/SoftLayer_Notification_Occurrence_Event).
-
SoftLayer_Notification_Occurrence_Resource_Network_Storage_Iscsi_NetApp
This type contains general information related to a [SoftLayer_Network_Storage_Iscsi_NetApp](/reference/datatypes/SoftLayer_Network_Storage_Iscsi_NetApp) resource that is impacted by a [SoftLayer_Notification_Occurrence_Event](/reference/datatypes/SoftLayer_Notification_Occurrence_Event).
-
SoftLayer_Notification_Occurrence_Resource_Network_Storage_Lockbox
This type contains general information related to a [SoftLayer_Network_Storage_Lockbox](/reference/datatypes/SoftLayer_Network_Storage_Lockbox) resource that is impacted by a [SoftLayer_Notification_Occurrence_Event](/reference/datatypes/SoftLayer_Notification_Occurrence_Event).
-
SoftLayer_Notification_Occurrence_Resource_Network_Storage_Nas
This type contains general information related to a [SoftLayer_Network_Storage_Nas](/reference/datatypes/SoftLayer_Network_Storage_Nas) resource that is impacted by a [SoftLayer_Notification_Occurrence_Event](/reference/datatypes/SoftLayer_Notification_Occurrence_Event).
-
SoftLayer_Notification_Occurrence_Resource_Network_Storage_NetApp_Volume
This type contains general information related to a [SoftLayer_Network_Storage](/reference/datatypes/SoftLayer_Network_Storage) resource that is impacted by a [SoftLayer_Notification_Occurrence_Event](/reference/datatypes/SoftLayer_Notification_Occurrence_Event).
-
SoftLayer_Notification_Occurrence_Resource_Network_Storage_NetApp_Volume_Replicant_Iscsi
This type contains general information related to a [SoftLayer_Network_Storage_Iscsi](/reference/datatypes/SoftLayer_Network_Storage_Iscsi) resource that is impacted by a [SoftLayer_Notification_Occurrence_Event](/reference/datatypes/SoftLayer_Notification_Occurrence_Event).
-
SoftLayer_Notification_Occurrence_Resource_Network_Storage_NetApp_Volume_Replicant_Nas
This type contains general information related to a [SoftLayer_Network_Storage_NetApp_Volume_Replicant_Nas](/reference/datatypes/SoftLayer_Network_Storage_NetApp_Volume_Replicant_Nas) resource that is impacted by a [SoftLayer_Notification_Occurrence_Event](/reference/datatypes/SoftLayer_Notification_Occurrence_Event).
-
SoftLayer_Notification_Occurrence_Resource_Virtual
This type contains general information related to a [SoftLayer_Virtual_Guest](/reference/datatypes/SoftLayer_Virtual_Guest) resource that is impacted by a [SoftLayer_Notification_Occurrence_Event](/reference/datatypes/SoftLayer_Notification_Occurrence_Event).
-
SoftLayer_Notification_Occurrence_Status_Code
-
SoftLayer_Notification_Occurrence_Update
-
SoftLayer_Notification_Occurrence_User
This type contains general information relating to a user that may be impacted by a [SoftLayer_Notification_Occurrence_Event](/reference/datatypes/SoftLayer_Notification_Occurrence_Event).
-
SoftLayer_Notification_Preference
Retrieve details for preferences. Preferences are used to allow the subscriber to modify their subscription in various ways. Details such as friendly name, keyname maximum and minimum values can be retrieved. These provide details to help configure subscriber preferences correctly.
-
SoftLayer_Notification_Subscriber
-
SoftLayer_Notification_Subscriber_Customer
-
SoftLayer_Notification_Subscriber_Delivery_Method
Provides details for the subscriber's delivery methods.
-
SoftLayer_Notification_User_Subscriber
A notification subscriber will have details pertaining to the subscriber's notification subscription. You can receive details such as preferences, details of the preferences, delivery methods and the delivery methods for the subscriber.
NOTE: There are preferences and delivery methods that cannot be modified. Also, there are some subscriptions that are required.
-
SoftLayer_Notification_User_Subscriber_Billing
A notification subscriber will have details pertaining to the subscriber's notification subscription. You can receive details such as preferences, details of the preferences, delivery methods and the delivery methods for the subscriber.
NOTE: There are preferences and delivery methods that cannot be modified. Also, there are some subscriptions that are required.
-
SoftLayer_Notification_User_Subscriber_Delivery_Method
Provides mapping details of how the subscriber's notification will be delivered. This maps the subscriber's id with all the delivery method ids used to delivery the notification.
-
SoftLayer_Notification_User_Subscriber_Mobile
A notification subscriber will have details pertaining to the subscriber's notification subscription. You can receive details such as preferences, details of the preferences, delivery methods and the delivery methods for the subscriber.
NOTE: There are preferences and delivery methods that cannot be modified. Also, there are some subscriptions that are required.
-
SoftLayer_Notification_User_Subscriber_Preference
Preferences are settings that can be modified to change the behavior of the subscription. For example, modify the limit preference to only receive notifications 10 times instead of 1 during a billing cycle.
NOTE: Some preferences have certain restrictions on values that can be set.
-
SoftLayer_Notification_User_Subscriber_Resource
Retrieve identifier cross-reference information. SoftLayer_Notification_User_Subscriber_Resource provides the resource table id and subscriber id relation. The resource table id is the id of the service the subscriber receives alerts for. This resource table id could be the unique identifier for a Storage Evault service or CDN service.
-
SoftLayer_Policy_Document_Acceptance_Quote
The SoftLayer_Billing_Oder_Quote data type records acceptance of policy documents for a quote.
-
SoftLayer_Product_Catalog
A Catalog is defined as a set of prices for products that SoftLayer offers for sale. These prices are organized into packages which represent the different servers and services that SoftLayer offers.
-
SoftLayer_Product_Catalog_Item_Price
The SoftLayer_Product_Catalog_Item_Price type assigns an Item Price to a Catalog. This relation defines the composition of Item Prices in a Catalog.
-
SoftLayer_Product_Group
The SoftLayer_Product_Group data type contains product group relationship.
-
SoftLayer_Product_Item
The SoftLayer_Product_Item data type contains general information relating to a single SoftLayer product.
-
SoftLayer_Product_Item_Attribute
The [SoftLayer_Product_Item_Attribute](/reference/datatypes/SoftLayer_Product_Item_Attribute) data type allows us to describe a [SoftLayer_Product_Item](/reference/datatypes/SoftLayer_Product_Item) by attaching specific attributes, which may dictate how it interacts with other products and services. Most, if not all, of these attributes are geared towards internal usage, so customers should rarely be concerned with them.
-
SoftLayer_Product_Item_Attribute_Type
The [SoftLayer_Product_Item_Attribute_Type](/reference/datatypes/SoftLayer_Product_Item_Attribute_Type) data type defines the available type of product attributes that are available. This allows for convenient reference to a [SoftLayer_Product_Item_Attribute](/reference/datatypes/SoftLayer_Product_Item_Attribute) by a unique key name value.
-
SoftLayer_Product_Item_Billing_Type
The SoftLayer_Product_Item_Billing_Type data type models special billing types for non-monthly billed items in the SoftLayer product catalog.
-
SoftLayer_Product_Item_Bundles
The SoftLayer_Product_Item_Bundles contains item to price cross references. Relates a category, price and item to a bundle. Match bundle ids to see all items and prices in a particular bundle.
-
SoftLayer_Product_Item_Category
The SoftLayer_Product_Item_Category data type contains general category information for prices.
-
SoftLayer_Product_Item_Category_Group
The SoftLayer_Product_Item_Category_Group data type contains general category group information.
-
SoftLayer_Product_Item_Category_Order_Option_Type
The SoftLayer_Product_Item_Category_Order_Option_Type data type contains options that can be applied to orders for prices.
-
SoftLayer_Product_Item_Category_Question
The SoftLayer_Product_Item_Category_Question data type represents a single question to be answered by an end user. The question may or may not be required which can be located by looking at the 'required' property on the item category references. The answerValueExpression property is a regular expression that is used to validate the answer to the question. The description and valueExample properties can be used to get an idea of the type of answer that should be provided.
-
SoftLayer_Product_Item_Category_Question_Field_Type
The SoftLayer_Product_Item_Category_Question_Field_Type data type represents the recommended type of field that should be rendered on an HTML form.
-
SoftLayer_Product_Item_Category_Question_Xref
The SoftLayer_Product_Item_Category_Question_Xref data type represents a link between an item category and an item category question. It also contains a 'required' field that designates if the question is required to be answered for the given item category.
-
SoftLayer_Product_Item_Overage_Price
-
SoftLayer_Product_Item_Policy_Assignment
Represents the assignment of a policy to a product. The existence of a record means that the associated product is subject to the terms defined in the document content of the policy.
-
SoftLayer_Product_Item_Price
The SoftLayer_Product_Item_Price data type contains general information relating to a single SoftLayer product item price. You can find out what packages each price is in as well as which category under which this price is sold. All prices are returned in floating point values measured in US Dollars ($USD).
-
SoftLayer_Product_Item_Price_Account_Restriction
The SoftLayer_Product_Item_Price data type gives more information about the item price restrictions. An item price may be restricted to one or more accounts. If the item price is restricted to an account, only that account will see the restriction details.
-
SoftLayer_Product_Item_Price_Attribute
-
SoftLayer_Product_Item_Price_Attribute_Type
-
SoftLayer_Product_Item_Price_Premium
-
SoftLayer_Product_Item_Requirement
The SoftLayer_Product_Item_Requirement data type contains information relating to what requirements, if any, exist for an item. The requiredItemId local property is the item id that is required.
-
SoftLayer_Product_Item_Resource_Conflict
-
SoftLayer_Product_Item_Resource_Conflict_Item
-
SoftLayer_Product_Item_Resource_Conflict_Item_Category
-
SoftLayer_Product_Item_Resource_Conflict_Location
-
SoftLayer_Product_Item_Rule
The item rule data type represents a rule that must be followed when the item assigned to the rule is ordered. The type and operation applied to the resources of the rule will affect how the rule is checked during ordering.
-
SoftLayer_Product_Item_Rule_Resource
The item rule resource data type represents a resource that is part of an item rule. The item rule resource is used when its item rule is checked on an order.
-
SoftLayer_Product_Item_Rule_Resource_Item
-
SoftLayer_Product_Item_Rule_Resource_Item_Category
-
SoftLayer_Product_Item_Rule_Resource_Location
-
SoftLayer_Product_Item_Rule_Resource_Permission
-
SoftLayer_Product_Item_Rule_Type
The item rule type data type represents the type of an item rule.
-
SoftLayer_Product_Item_Server_Group
The SoftLayer_Product_Item_Server_Group data type details the type of compute service a [SoftLayer_Product_Item](/reference/datatypes/SoftLayer_Product_Item) or [SoftLayer_Product_Package_Preset](/reference/datatypes/SoftLayer_Product_Package_Preset) belongs to.
-
SoftLayer_Product_Item_Tax_Category
The SoftLayer_Product_Item_Tax_Category data type contains the tax categories that are associated with products.
-
SoftLayer_Product_Order
All orders (servers, virtual servers and services) pass through the [SoftLayer_Product_Order](/reference/datatypes/SoftLayer_Product_Order) service. This service provides the entry point for placing orders and quotes with SoftLayer. To place orders using these services, you must provide the appropriate container type as defined by [SoftLayer_Container_Product_Order](/reference/datatypes/SoftLayer_Container_Product_Order). For server orders, you would use [SoftLayer_Container_Product_Order_Hardware_Server](/reference/datatypes/SoftLayer_Container_Product_Order_Hardware_Server). For virtual server orders, you would use [SoftLayer_Container_Product_Order_Virtual_Guest](/reference/datatypes/SoftLayer_Container_Product_Order_Virtual_Guest). For additional service orders, it will depend on the additional service (e.g., network attached storage, object storage) being purchased. See the data types documentation to get a list of all the available container types beginning with `SoftLayer_Container_Product_Order_*`.
There are several main entry points associated with ordering:
- [SoftLayer_Product_Order::placeOrder](/reference/services/SoftLayer_Product_Order/placeOrder) Order servers and services. Your credit card or PayPal account will get charged when successfully placed.
- [SoftLayer_Product_Order::verifyOrder](/reference/services/SoftLayer_Product_Order/verifyOrder) Run verification on your order before it's actually placed to get additional information, like your total monthly or hourly recurring charges. You may also call this service to help ensure that your call to [SoftLayer_Product_Order::placeOrder](/reference/services/SoftLayer_Product_Order/placeOrder) will succeed. **This service is called internally, so it is not required to verify before you call `placeOrder`.** No credit card or PayPal charges result from this call.
- [SoftLayer_Product_Order::placeQuote](/reference/services/SoftLayer_Product_Order/placeQuote) Create a quote only. Subsequent orders may be placed from this quote. See [SoftLayer_Billing_Order_Quote::placeOrder](/reference/services/SoftLayer_Billing_Order_Quote/placeOrder) for details on how to order from a quote.
- [SoftLayer_Product_Order::getVlans](/reference/services/SoftLayer_Product_Order/getVlans) Get a list of available VLANs that can be supplied when placing an order.
While this service provides detailed customization for ordering, some customers may find the simplified ordering system sufficient for their needs. For more information, see the following:
- [SoftLayer_Virtual_Guest::createObject](/reference/services/SoftLayer_Virtual_Guest/createObject) - Simplified virtual server ordering
- [SoftLayer_Hardware::createObject](/reference/services/SoftLayer_Hardware/createObject) - Simplified bare metal server ordering
-
SoftLayer_Product_Package
The SoftLayer_Product_Package data type contains information about packages from which orders can be generated. Packages contain general information regarding what is in them, where they are currently sold, availability, and pricing.
-
SoftLayer_Product_Package_Attribute
-
SoftLayer_Product_Package_Attribute_Type
-
SoftLayer_Product_Package_Inventory
This is deprecated.
-
SoftLayer_Product_Package_Item_Category_Group
This class is used to organize categories for a service offering. A service offering (usually) contains multiple categories (e.g., server, os, disk0, ram). This class allows us to organize the prices into related item category groups.
-
SoftLayer_Product_Package_Item_Prices
The SoftLayer_Product_Package_Item_Prices contains price to package cross references Relates a category, price and item to a bundle. Match bundle ids to see all items and prices in a particular bundle.
-
SoftLayer_Product_Package_Items
This data type is a cross-reference between the SoftLayer_Product_Package and the SoftLayer_Product_Item(s) that belong in the SoftLayer_Product_Package.
-
SoftLayer_Product_Package_Locations
Most packages are available in many locations. This object describes that availability for each package.
-
SoftLayer_Product_Package_Order_Configuration
This datatype describes the item categories that are required for each package to be ordered. For instance, for package 2, there will be many required categories. When submitting an order for a server, there must be at most 1 price for each category whose 'isRequired' is set. Examples of required categories: - server - ram - bandwidth - disk0
There are others, but these are the main ones. For each required category, a SoftLayer_Product_Item_Price must be chosen that is valid for the package.
-
SoftLayer_Product_Package_Order_Step
Each package has at least 1 step to the ordering process. For server orders, there are many. Each step has certain item categories which are displayed. This type describes the steps for each package.
-
SoftLayer_Product_Package_Order_Step_Next
This datatype simply describes which steps are next in line for ordering.
-
SoftLayer_Product_Package_Preset
Package presets are used to simplify ordering by eliminating the need for price ids when submitting orders.
Orders submitted with a preset id defined will use the prices included in the package preset. Prices submitted on an order with a preset id will replace the prices included in the package preset for that prices category. If the package preset has a fixed configuration flag <em>(fixedConfigurationFlag)</em> set then the prices included in the preset configuration cannot be replaced by prices submitted on the order. The only exception to the fixed configuration flag would be if a price submitted on the order is an account-restricted price for the same product item.
-
SoftLayer_Product_Package_Preset_Attribute
Package preset attributes contain supplementary information for a package preset.
-
SoftLayer_Product_Package_Preset_Attribute_Type
SoftLayer_Product_Package_Preset_Attribute_Type models the type of attribute that can be assigned to a package preset.
-
SoftLayer_Product_Package_Preset_Configuration
-
SoftLayer_Product_Package_Server
The SoftLayer_Product_Package_Server data type contains summarized information for bare metal servers regarding pricing, processor stats, and feature sets.
-
SoftLayer_Product_Package_Server_Option
The [SoftLayer_Product_Package_Server_Option](/reference/datatypes/SoftLayer_Product_Package_Server_Option) data type contains various data points associated with package servers that can be used in selection criteria.
-
SoftLayer_Product_Package_Type
The [SoftLayer_Product_Package_Type](/reference/datatypes/SoftLayer_Product_Package_Type) object indicates the type for a service offering (package). The type can be used to filter packages. For example, if you are looking for the package representing virtual servers, you can filter on the type's key name of '''VIRTUAL_SERVER_INSTANCE'''. For bare metal servers by core or CPU, filter on '''BARE_METAL_CORE''' or '''BARE_METAL_CPU''', respectively.
-
SoftLayer_Product_Promotion
The promotion web service is used to find information regarding a specific promotion using a promotion code.
-
SoftLayer_Product_Upgrade_Request
The SoftLayer_Product_Upgrade_Request data type contains general information relating to a hardware, virtual server, or service upgrade. It also relates a [SoftLayer_Billing_Order](/reference/datatypes/SoftLayer_Billing_Order) to a [SoftLayer_Ticket](/reference/datatypes/SoftLayer_Ticket).
-
SoftLayer_Product_Upgrade_Request_Status
The SoftLayer_Product_Upgrade_Request_Status data type contains detailed information relating to an hardware or software upgrade request.
-
SoftLayer_Provisioning_Hook
The SoftLayer_Provisioning_Hook contains all the information needed to add a hook into a server/Virtual provision and os reload.
-
SoftLayer_Provisioning_Hook_Type
-
SoftLayer_Provisioning_Maintenance_Classification
The SoftLayer_Provisioning_Maintenance_Classification represent a maintenance type for the specific hardware maintenance desired.
-
SoftLayer_Provisioning_Maintenance_Classification_Item_Category
-
SoftLayer_Provisioning_Maintenance_Slots
The SoftLayer_Provisioning_Maintenance_Slots represent the available slots for a given maintenance window at a SoftLayer data center.
-
SoftLayer_Provisioning_Maintenance_Ticket
-
SoftLayer_Provisioning_Maintenance_Window
The SoftLayer_Provisioning_Maintenance_Window represent a time window that SoftLayer performs a hardware or software maintenance and upgrades.
-
SoftLayer_Provisioning_Version1_Transaction
The SoftLayer_Provisioning_Version1_Transaction data type contains general information relating to a single SoftLayer hardware transaction.
SoftLayer customers are unable to change their hardware transactions.
-
SoftLayer_Provisioning_Version1_Transaction_Group
The SoftLayer_Provisioning_Version1_Transaction_Group data type contains general information relating to a single SoftLayer hardware transaction group.
SoftLayer customers are unable to change their hardware transactions or the hardware transaction group.
-
SoftLayer_Provisioning_Version1_Transaction_History
-
SoftLayer_Provisioning_Version1_Transaction_OrderTracking
Provisioning Order Tracking
-
SoftLayer_Provisioning_Version1_Transaction_OrderTrackingState
Provisioning Order Tracking
-
SoftLayer_Provisioning_Version1_Transaction_Status
The SoftLayer_Provisioning_Version1_Transaction_Status data type contains general information relating to a single SoftLayer hardware transaction status.
SoftLayer customers are unable to change their hardware transaction status.
-
SoftLayer_Resource_Configuration
The Resource Configuration service enables the user to update data regarding a resource from which the request originates. It is a requirement that the request must have an authentication token as well as originate from the backend network of the resource.
-
SoftLayer_Resource_Group
SoftLayer's resource group service allows users to access a broad overview of the resource group and its members
-
SoftLayer_Resource_Group_Attribute
-
SoftLayer_Resource_Group_Attribute_Type
-
SoftLayer_Resource_Group_Descendant_Reference
The SoftLayer_Resource_Group_Descendant_Reference data type simplifies the link between one SoftLayer_Resource_Group_Member object and all of its parents.
-
SoftLayer_Resource_Group_Member
-
SoftLayer_Resource_Group_Member_Attribute
-
SoftLayer_Resource_Group_Member_Attribute_Type
-
SoftLayer_Resource_Group_Member_CloudStack_Version3_Cluster
-
SoftLayer_Resource_Group_Member_CloudStack_Version3_Pod
-
SoftLayer_Resource_Group_Member_CloudStack_Version3_Zone
-
SoftLayer_Resource_Group_Member_Hardware
-
SoftLayer_Resource_Group_Member_Network_Storage
-
SoftLayer_Resource_Group_Member_Network_Subnet
-
SoftLayer_Resource_Group_Member_Network_Vlan
-
SoftLayer_Resource_Group_Member_Resource_Group
-
SoftLayer_Resource_Group_Member_Role_Link
-
SoftLayer_Resource_Group_Member_Software_Component_Password
-
SoftLayer_Resource_Group_Member_Type
-
SoftLayer_Resource_Group_Member_Virtual_Host_Pool
-
SoftLayer_Resource_Group_Role
-
SoftLayer_Resource_Group_Template
-
SoftLayer_Resource_Group_Template_Member
-
SoftLayer_Resource_Metadata
The Resource Metadata service enables the user to obtain information regarding the resource from which the request originates. Due to the requirement that the request originate from the backend network of the resource, no API key is necessary to perform the request.
The primary use of this service is to allow self-discovery for newly provisioned resources, enabling further automated setup by the user.
-
SoftLayer_Sales_Presale_Event
The presale event data types indicate the information regarding an individual presale event. The '''locationId''' will indicate the datacenter associated with the presale event. The '''itemId''' will indicate the product item associated with a particular presale event - however these are more rare. The '''startDate''' and '''endDate''' will provide information regarding when the presale event is available for use. At the end of the presale event, the server or services purchased will be available once approved and provisioned.
-
SoftLayer_Search
SoftLayer's account historical service allows users to access a broad overview of devices for that account and historical details concerning the overall function and performance of the devices on that account
-
SoftLayer_Security_Certificate
-
SoftLayer_Security_Certificate_Entry
-
SoftLayer_Security_Certificate_Request
The SoftLayer_Security_Certificate_Request data type is used to view details about your SSL certificate order. This contains data that is required by a Certificate Authority to place an SSL certificate order.
-
SoftLayer_Security_Certificate_Request_ServerType
Represents a server type that can be specified when ordering an SSL certificate.
-
SoftLayer_Security_Certificate_Request_Status
Represents the status of an SSL certificate request.
-
SoftLayer_Security_Directory_Service_Host_Xref_Hardware
SoftLayer_Security_Directory_Service_Host_Xref_Hardware extends the [SoftLayer_Security_Directory_Service_Host_Xref](/reference/datatypes/SoftLayer_Security_Directory_Service_Host_Xref) data type to include hardware specific properties.
-
SoftLayer_Security_Level
The SoftLayer_Security_Level data type contains the security level restriction for the account
-
SoftLayer_Security_SecureTransportCipher
Encryption algorithm intended for use in SSL/TLS communications
-
SoftLayer_Security_SecureTransportProtocol
Protocol intended for use in secure communications
-
SoftLayer_Security_Ssh_Key
-
SoftLayer_Service_External_Resource
The SoftLayer_Service_External_Resource is a placeholder that references a service being provided outside of the standard SoftLayer system.
-
SoftLayer_Service_Provider
-
SoftLayer_Software_AccountLicense
SoftLayer_Software_AccountLicense is a class that represents software licenses that are tied only to a customer's account and not to any particular hardware, IP address, etc.
-
SoftLayer_Software_Component
A SoftLayer_Software_Component ties the installation of a specific piece of software onto a specific piece of hardware.
SoftLayer_Software_Component works with SoftLayer_Software_License and SoftLayer_Software_Description to tie this all together.
<ul> <li>SoftLayer_Software_Component is the installation of a specific piece of software onto a specific piece of hardware in accordance to a software license. <ul> <li>SoftLayer_Software_License dictates when and how a specific piece of software may be installed onto a piece of hardware. <ul> <li>SoftLayer_Software_Description describes a specific piece of software which can be installed onto hardware in accordance with it's license agreement. </li></ul></li></ul></li></ul>
-
SoftLayer_Software_Component_Analytics
This object specifies a specific type of Software Component: An analytics instance. Analytics installations have a specific default ports and patterns for usernames and passwords. Defaults are initiated by this object.
-
SoftLayer_Software_Component_Analytics_Urchin
This object specifies a specific Software Component: An Urchin instance. Urchin installations have a specific default port (9999) and a pattern for usernames and passwords. Defaults are initiated by this object.
-
SoftLayer_Software_Component_AntivirusSpyware
This object specifies a specific type of Software Component: An Anti-virus/spyware instance. Anti-virus/spyware installations have specific properties and methods such as SoftLayer_Software_Component_AntivirusSpyware::updateAntivirusSpywarePolicy. Defaults are initiated by this object.
-
SoftLayer_Software_Component_AntivirusSpyware_Mcafee
The SoftLayer_Software_Component_AntivirusSpyware_Mcafee represents a single anti-virus/spyware software component.
-
SoftLayer_Software_Component_AntivirusSpyware_Mcafee_Epo_Version36
The SoftLayer_Software_Component_AntivirusSpyware_Mcafee_Epo_Version36 data type represents a single McAfee Secure anti-virus/spyware software component that uses the ePolicy Orchestrator version 3.6 backend.
-
SoftLayer_Software_Component_AntivirusSpyware_Mcafee_Epo_Version45
The SoftLayer_Software_Component_AntivirusSpyware_Mcafee_Epo_Version45 data type represents a single McAfee Secure anti-virus/spyware software component that uses the ePolicy Orchestrator version 4.5 backend.
-
SoftLayer_Software_Component_AntivirusSpyware_Mcafee_Epo_Version51
The SoftLayer_Software_Component_AntivirusSpyware_Mcafee_Epo_Version51 data type represents a single McAfee Secure anti-virus/spyware software component that contacts the McAfee ePO Server version 5.1 backend.
-
SoftLayer_Software_Component_ControlPanel
This object specifies a specific type of Software Component: A control panel instance. Control panel installations have a specific default ports and patterns for usernames and passwords. Defaults are initiated by this object.
-
SoftLayer_Software_Component_ControlPanel_Cpanel
This object specifies a specific Software Component: A cPanel instance. cPanel installations have a specific default port (2086) and a pattern for usernames and passwords. Defaults are initiated by this object.
-
SoftLayer_Software_Component_ControlPanel_Idera
This object specifies a specific type of control panel Software Component: An Idera instance.
-
SoftLayer_Software_Component_ControlPanel_Idera_ServerBackup
This object specifies a specific type of Software Component: A Idera Server Backup instance.
-
SoftLayer_Software_Component_ControlPanel_Microsoft
This object is a parent class for Microsoft Products, like Web Matrix
-
SoftLayer_Software_Component_ControlPanel_Microsoft_WebPlatform
This object specifies a specific Software Component: A WebPlatform instance. WebPlatform installations have a specific xml config with usernames and passwords. Defaults are initiated by this object.
-
SoftLayer_Software_Component_ControlPanel_Parallels
This object is a parent class for SWSoft Products, like Plesk
-
SoftLayer_Software_Component_ControlPanel_Parallels_Plesk
This object specifies a specific Software Component: A Plesk instance produced by SWSoft. SWSoft Plesk installations have a specific default port (8443) and a pattern for usernames and passwords. Defaults are initiated by this object.
-
SoftLayer_Software_Component_ControlPanel_R1soft
This object specifies a specific type of control panel Software Component: A R1soft instance.
-
SoftLayer_Software_Component_ControlPanel_R1soft_Cdp
This object specifies a specific type of Software Component: A R1soft continuous data protection instance.
-
SoftLayer_Software_Component_ControlPanel_R1soft_ServerBackup
This object specifies a specific type of Software Component: A R1Soft Server Backup instance.
-
SoftLayer_Software_Component_ControlPanel_Swsoft
This object is a parent class for SWSoft Products, like Plesk
-
SoftLayer_Software_Component_ControlPanel_WebhostAutomation
This object specifies a specific Software Component: A Helm instance produced by Webhost Automation. WEbhost Automation's Helm installations have a specific default port (8086) and a pattern for usernames and passwords. Defaults are initiated by this object.
-
SoftLayer_Software_Component_HostIps
This object specifies a specific type of Software Component: A Host Intrusion Protection System instance.
-
SoftLayer_Software_Component_HostIps_Mcafee
The SoftLayer_Software_Component_HostIps_Mcafee represents a single host IPS software component.
-
SoftLayer_Software_Component_HostIps_Mcafee_Epo_Version36_Hips
The SoftLayer_Software_Component_HostIps_Mcafee_Epo_Version36_Hips data type represents a single McAfee Secure Host IPS software component that uses the ePolicy Orchestrator version 3.6 backend.
-
SoftLayer_Software_Component_HostIps_Mcafee_Epo_Version36_Hips_Version6
The SoftLayer_Software_Component_HostIps_Mcafee_Epo_Version36_Hips_Version6 data type represents a single McAfee Secure Host IPS software component for version 6 of the Host IPS client and uses the ePolicy Orchestrator version 3.6 backend.
-
SoftLayer_Software_Component_HostIps_Mcafee_Epo_Version36_Hips_Version7
The SoftLayer_Software_Component_HostIps_Mcafee_Epo_Version36_Hips_Version7 data type represents a single McAfee Secure Host IPS software component for version 7 of the Host IPS client and uses the ePolicy Orchestrator version 3.6 backend.
-
SoftLayer_Software_Component_HostIps_Mcafee_Epo_Version45_Hips
The SoftLayer_Software_Component_HostIps_Mcafee_Epo_Version45_Hips data type represents a single McAfee Secure Host IPS software component that uses the ePolicy Orchestrator version 4.5 backend.
-
SoftLayer_Software_Component_HostIps_Mcafee_Epo_Version45_Hips_Version7
The SoftLayer_Software_Component_HostIps_Mcafee_Epo_Version45_Hips_Version7 data type represents a single McAfee Secure Host IPS software component for version 7 of the Host IPS client and uses the ePolicy Orchestrator version 4.5 backend.
-
SoftLayer_Software_Component_HostIps_Mcafee_Epo_Version45_Hips_Version8
The SoftLayer_Software_Component_HostIps_Mcafee_Epo_Version45_Hips_Version8 data type represents a single McAfee Secure Host IPS software component for version 8 of the Host IPS client and uses the ePolicy Orchestrator version 4.5 backend.
-
SoftLayer_Software_Component_HostIps_Mcafee_Epo_Version51
The SoftLayer_Software_Component_HostIps_Mcafee_Epo_Version51 data type represents a single McAfee Secure Host IPS software component that uses the ePO Server.
-
SoftLayer_Software_Component_OperatingSystem
SoftLayer_Software_Component_OperatingSystem extends the [SoftLayer_Software_Component](/reference/datatypes/SoftLayer_Software_Component) data type to include operating system specific properties.
-
SoftLayer_Software_Component_Package
This object specifies a specific type of Software Component: A package instance.
-
SoftLayer_Software_Component_Package_Management
This object specifies a specific type of Software Component: A package management instance.
-
SoftLayer_Software_Component_Package_Management_Ksplice
This object specifies a specific type of Software Component: A Ksplice instance.
-
SoftLayer_Software_Component_Password
This SoftLayer_Software_Component_Password data type contains a password for a specific software component instance.
-
SoftLayer_Software_Component_Password_History
This object allows you to find the history of password changes for a specific SoftLayer_Software Component
-
SoftLayer_Software_Component_Security
This object specifies a specific type of Software Component: A security instance. Security installations have custom configurations for password requirements.
-
SoftLayer_Software_Component_Security_SafeNet
This object specifies a specific Software Component: A SafeNet instance. SafeNet installations have custom configurations for password requirements.
-
SoftLayer_Software_Component_Trellix
This object specifies a specific type of Software Component: An Trellix instance. Trellix installations have specific properties and methods such as SoftLayer_Software_Component_Trellix::updateTrellixPolicy. Defaults are initiated by this object.
-
SoftLayer_Software_Description
This class holds a description for a specific installation of a Software Component.
SoftLayer_Software_Licenses tie a Software Component (A specific installation on a piece of hardware) to it's description.
The 'Manufacturer' and 'Name' properties of a SoftLayer_Software_Description are used by the framework to factory specific objects, objects that may have special methods for that specific piece of software, or objects that contain application specific data, such as default ports. For example, if you create a SoftLayer_Software_Component who's SoftLayer_Software_License points to the SoftLayer_Software_Description for 'Swsoft' 'Plesk', you'll actually get a SoftLayer_Software_Component_Swsoft_Plesk object.
-
SoftLayer_Software_Description_Attribute
The SoftLayer_Software_Description_Attribute data type represents an attributes associated with this software description.
-
SoftLayer_Software_Description_Attribute_Type
The SoftLayer_Software_Description_Attribute_Type data type represents the type of an attribute.
-
SoftLayer_Software_Description_Feature
The SoftLayer_Software_Description_Feature data type represents a single software description feature. A feature may show up on more than one software description and can not be created, modified, or removed.
-
SoftLayer_Software_Description_RequiredUser
This class represents a software description's required user
-
SoftLayer_Software_License
This class describes a specific type of license, like a Microsoft Windows Site License, a GPL license, or a license of another type.
-
SoftLayer_Software_VirtualLicense
SoftLayer_Software_VirtualLicense is the application class that handles a special type of Software License. Most software licenses are licensed to a specific hardware ID; virtual licenses are designed for virtual machines and therefore are assigned to an IP Address. Not all software packages can be 'virtual licensed'.
-
SoftLayer_Survey
The SoftLayer_Survey data type contains general information relating to a single SoftLayer survey.
-
SoftLayer_Survey_Answer
The SoftLayer_Survey_Answer data type contains general information relating to a single SoftLayer survey answer.
-
SoftLayer_Survey_Question
The SoftLayer_Survey_Question data type contains general information relating to a single SoftLayer survey question.
-
SoftLayer_Survey_Response
The SoftLayer_Survey_Response data type contains general information relating to a single SoftLayer survey response.
-
SoftLayer_Survey_Status
The SoftLayer_Survey_Status data type contains survey status information.
-
SoftLayer_Survey_Type
The SoftLayer_Survey_Type data type contains survey type information.
-
SoftLayer_Tag
The SoftLayer_Tag data type is an optional type associated with hardware. The account ID that the tag is tied to, and the tag itself are stored in this data type. There is also a flag to denote whether the tag is internal or not.
-
SoftLayer_Tag_Reference
-
SoftLayer_Tag_Reference_Hardware
-
SoftLayer_Tag_Reference_Network_Application_Delivery_Controller
-
SoftLayer_Tag_Reference_Network_Vlan
-
SoftLayer_Tag_Reference_Network_Vlan_Firewall
-
SoftLayer_Tag_Reference_Resource_Group
-
SoftLayer_Tag_Reference_Virtual_DedicatedHost
-
SoftLayer_Tag_Reference_Virtual_Guest
-
SoftLayer_Tag_Reference_Virtual_Guest_Block_Device_Template_Group
-
SoftLayer_Tag_Type
-
SoftLayer_Ticket
The SoftLayer_Ticket data type models a single SoftLayer customer support or notification ticket. Each ticket object contains references to it's updates, the user it's assigned to, the SoftLayer department and employee that it's assigned to, and any hardware objects or attached files associated with the ticket. Tickets are described in further detail on the [SoftLayer_Ticket](/reference/datatypes/SoftLayer_Ticket) service page.
To create a support ticket execute the [SoftLayer_Ticket::createStandardTicket](/reference/datatypes/$1/#$2) or [SoftLayer_Ticket::createAdministrativeTicket](/reference/datatypes/$1/#$2) methods in the SoftLayer_Ticket service. To create an upgrade ticket for the SoftLayer sales group execute the [SoftLayer_Ticket::createUpgradeTicket](/reference/datatypes/$1/#$2).
-
SoftLayer_Ticket_Activity
-
SoftLayer_Ticket_Attachment
SoftLayer tickets have the ability to be associated with specific pieces of hardware in a customer's inventory. Attaching hardware to a ticket can greatly increase response time from SoftLayer for issues that are related to one or more specific servers on a customer's account. The SoftLayer_Ticket_Attachment_Hardware data type models the relationship between a piece of hardware and a ticket. Only one attachment record may exist per hardware item per ticket.
-
SoftLayer_Ticket_Attachment_Assigned_Agent
-
SoftLayer_Ticket_Attachment_CardChangeRequest
This datatype contains tickets referenced from card change request
-
SoftLayer_Ticket_Attachment_Dedicated_Host
SoftLayer tickets have the ability to be associated with specific dedicated hosts in a customer's inventory. Attaching a dedicated host to a ticket can greatly increase response time from SoftLayer for issues that are related to one or more specific hosts on a customer's account. The SoftLayer_Ticket_Attachment_Dedicated_Host data type models the relationship between a dedicated host and a ticket. Only one attachment record can exist per dedicated host item per ticket.
-
SoftLayer_Ticket_Attachment_File
SoftLayer tickets can have have files attached to them. Attaching a file to a ticket is a good way to report issues, provide documentation, and give examples of an issue. Both SoftLayer customers and employees have the ability to attach files to a ticket. The SoftLayer_Ticket_Attachment_File data type models a single file attached to a ticket.
-
SoftLayer_Ticket_Attachment_File_ServiceNow
-
SoftLayer_Ticket_Attachment_Hardware
SoftLayer tickets have the ability to be associated with specific pieces of hardware in a customer's inventory. Attaching hardware to a ticket can greatly increase response time from SoftLayer for issues that are related to one or more specific servers on a customer's account. The SoftLayer_Ticket_Attachment_Hardware data type models the relationship between a piece of hardware and a ticket. Only one attachment record may exist per hardware item per ticket.
-
SoftLayer_Ticket_Attachment_Manual_Payment
This datatype contains tickets referenced from manual payments
-
SoftLayer_Ticket_Attachment_Network_Storage_Mass_Data_Migration
-
SoftLayer_Ticket_Attachment_Scheduled_Action
-
SoftLayer_Ticket_Attachment_Virtual_Guest
SoftLayer tickets have the ability to be associated with specific virtual guests in a customer's inventory. Attaching virtual guests to a ticket can greatly increase response time from SoftLayer for issues that are related to one or more specific servers on a customer's account. The SoftLayer_Ticket_Attachment_Virtual_Guest data type models the relationship between a virtual guest and a ticket. Only one attachment record may exist per virtual guest per ticket.
-
SoftLayer_Ticket_Chat
-
SoftLayer_Ticket_Chat_Liveperson
-
SoftLayer_Ticket_Chat_TranscriptLine
-
SoftLayer_Ticket_Chat_TranscriptLine_Customer
-
SoftLayer_Ticket_Chat_TranscriptLine_Employee
-
SoftLayer_Ticket_EuCompliance
-
SoftLayer_Ticket_Group
SoftLayer tickets have the ability to be assigned to one of SoftLayer's internal departments. The department that a ticket is assigned to is modeled by the SoftLayer_Ticket_Group data type. Ticket groups help to ensure that the proper department is handling a ticket. Standard support tickets are created from a number of pre-determined subjects. These subjects help determine which group a standard ticket is assigned to.
-
SoftLayer_Ticket_Group_Category
SoftLayer's support ticket groups represent the department at SoftLayer that is assigned to work one of your support tickets. Many departments are responsible for handling different types of tickets. These types of tickets are modeled in the SoftLayer_Ticket_Group_Category data type. Ticket group categories also help separate differentiate your tickets' issues in the SoftLayer customer portal.
-
SoftLayer_Ticket_Priority
-
SoftLayer_Ticket_State
-
SoftLayer_Ticket_State_Type
-
SoftLayer_Ticket_Status
The SoftLayer_Ticket_Status data type models the state of a ticket as it is worked by SoftLayer and its customers. Tickets exist in one of three states: *'''OPEN''': Open tickets are considered unresolved issues by SoftLayer and can be assigned to a SoftLayer employee for work. Tickets created by portal or API users are created in the Open state. *'''ASSIGNED''': Assigned tickets are identical to open tickets, but are assigned to an individual SoftLayer employee. An assigned ticket is actively being worked by SoftLayer. *'''CLOSED''': Tickets are closed when the issue at hand is considered resolved. A SoftLayer employee can change a ticket's status from Closed to Open or Assigned if the need arises.
A ticket usually goes from the Open to Assigned to Closed states during its life cycle. If a ticket is forwarded from one department to another it may change from the Assigned state back to Open until it is assigned to a member of the new department.
-
SoftLayer_Ticket_Subject
The SoftLayer_Ticket_Subject data type models one of the possible subjects that a standard support ticket may belong to. A basic support ticket's title matches it's corresponding subject's name.
-
SoftLayer_Ticket_Subject_Category
SoftLayer_Ticket_Subject_Category groups ticket subjects into logical group.
-
SoftLayer_Ticket_Survey
-
SoftLayer_Ticket_Type
-
SoftLayer_Ticket_Update
The SoftLayer_Ticket_Update type relates to a single update to a ticket, either by a customer or an employee.
-
SoftLayer_Ticket_Update_Agent
A SoftLayer_Ticket_Update_Agent type models an update to a ticket made by an agent.
-
SoftLayer_Ticket_Update_Chat
A SoftLayer_Ticket_Update_Chat is a chat between a customer and a customer service representative relating to a ticket.
-
SoftLayer_Ticket_Update_Customer
A SoftLayer_Ticket_Update_Customer is a single update made by a customer to a ticket.
-
SoftLayer_Ticket_Update_Employee
The SoftLayer_Ticket_Update_Employee data type models an update to a ticket made by a SoftLayer employee.
-
SoftLayer_Ticket_Update_Type
-
SoftLayer_User_Access_Facility_Log
This class represents a login/logout sheet for facility visitors.
-
SoftLayer_User_Access_Facility_Log_Type
-
SoftLayer_User_Access_Facility_Visitor
This class represents a facility visitor that is not an active employee or customer.
-
SoftLayer_User_Access_Facility_Visitor_Type
-
SoftLayer_User_Customer
The SoftLayer_User_Customer data type contains general information relating to a single SoftLayer customer portal user. Personal information in this type such as names, addresses, and phone numbers are not necessarily associated with the customer account the user is assigned to.
-
SoftLayer_User_Customer_Access_Authentication
SoftLayer_User_Customer_Access_Authentication models a single attempt to log into the SoftLayer customer portal. A SoftLayer_User_Customer_Access_Authentication record is created every time a user attempts to log into the portal. Use this service to audit your users' portal activity and diagnose potential security breaches of your SoftLayer portal accounts.
Unsuccessful login attempts can be caused by an incorrect password, failing to answer or not answering a login security question if the user has them configured, or attempting to log in from an IP address outside of the user's IP address restriction list.
SoftLayer employees periodically log into our customer portal as users to diagnose portal issues, verify settings and configuration, and to perform maintenance on your account or services. SoftLayer employees only log into customer accounts from the following IP ranges: * 2607:f0d0:1000::/48 * 2607:f0d0:2000::/48 * 2607:f0d0:3000::/48 * 66.228.118.67/32 * 66.228.118.86/32
-
SoftLayer_User_Customer_Access_Authentication_TokenValidation
SoftLayer_User_Customer_Access_Authentication_TokenValidation is for logging token validations from IAM, as something distinct from a traditional 'login'. A single login to IBM Cloud/IAM as perceived by the end user, may result in many token validation calls to IMS.
This is a very shallow subclass of SoftLayer_User_Customer_Access_Authentication
-
SoftLayer_User_Customer_AdditionalEmail
The SoftLayer_User_Customer_AdditionalEmail data type contains the additional email for use in ticket update notifications.
-
SoftLayer_User_Customer_ApiAuthentication
The SoftLayer_User_Customer_ApiAuthentication type contains user's authentication key(s).
-
SoftLayer_User_Customer_CustomerPermission_Permission
Each SoftLayer portal account is assigned a series of permissions that determine what access the user has to functions within the SoftLayer customer portal. This status is reflected in the SoftLayer_User_Customer_Status data type. Permissions differ from user status in that user status applies globally to the portal while user permissions are applied to specific portal functions.
-
SoftLayer_User_Customer_External_Binding
The SoftLayer_User_Customer_External_Binding data type contains general information for a single external binding. This includes the 3rd party vendor, type of binding, and a unique identifier and password that is used to authenticate against the 3rd party service.
-
SoftLayer_User_Customer_External_Binding_Attribute
The SoftLayer_User_Customer_External_Binding_Attribute data type contains the value for a single attribute associated with an external binding. External binding attributes contain additional information about an external binding. An attribute can be generic or specific to a 3rd party vendor. For example these attributes relate to Verisign: *Credential Type *Credential State *Credential Expiration Date *Credential Last Update Date
-
SoftLayer_User_Customer_External_Binding_Totp
The SoftLayer_User_Customer_External_Binding_Totp data type contains information about a single time-based one time password external binding. The external binding information is used when a SoftLayer customer logs into the SoftLayer customer portal to authenticate them.
The information provided by this external binding data type includes: * The type of credential * The current state of the credential ** Active ** Inactive
SoftLayer users with an active external binding will be prohibited from using the API for security reasons.
-
SoftLayer_User_Customer_External_Binding_Type
The SoftLayer_User_Customer_External_Binding_Type data type contains information relating to a type of external authentication binding. It contains a user friendly name as well as a unique key name.
-
SoftLayer_User_Customer_External_Binding_Vendor
The SoftLayer_User_Customer_External_Binding_Vendor data type contains information for a single external binding vendor. This information includes a user friendly vendor name, a unique version of the vendor name, and a unique internal identifier that can be used when creating a new external binding.
-
SoftLayer_User_Customer_External_Binding_Verisign
The SoftLayer_User_Customer_External_Binding_Verisign data type contains information about a single VeriSign external binding. The external binding information is used when a SoftLayer customer logs into the SoftLayer customer portal to authenticate them against a 3rd party, in this case VeriSign.
The information provided by the VeriSign external binding data type includes: * The type of credential * The current state of the credential ** Enabled ** Disabled ** Locked * The credential's expiration date * The last time the credential was updated
SoftLayer users with an active external binding will be prohibited from using the API for security reasons.
-
SoftLayer_User_Customer_Invitation
-
SoftLayer_User_Customer_Link
-
SoftLayer_User_Customer_Link_TrustedProfile
-
SoftLayer_User_Customer_Link_VerifiedIamIdLinkCollection
-
SoftLayer_User_Customer_Notification_Hardware
The Customer_Notification_Hardware object stores links between customers and the hardware devices they wish to monitor. This link is not enough, the user must be sure to also create SoftLayer_Network_Monitor_Version1_Query_Host instance with the response action set to 'notify users' in order for the users linked to that hardware object to be notified on failure.
-
SoftLayer_User_Customer_Notification_Virtual_Guest
The SoftLayer_User_Customer_Notification_Virtual_Guest object stores links between customers and the virtual guests they wish to monitor. This link is not enough, the user must be sure to also create SoftLayer_Network_Monitor_Version1_Query_Host instance with the response action set to 'notify users' in order for the users linked to that Virtual Guest object to be notified on failure.
-
SoftLayer_User_Customer_OpenIdConnect
-
SoftLayer_User_Customer_OpenIdConnect_TrustedProfile
-
SoftLayer_User_Customer_Profile_Event_HyperWarp
-
SoftLayer_User_Customer_Prospect
-
SoftLayer_User_Customer_Prospect_ServiceProvider_EnrollRequest
Contains user information for Service Provider Enrollment.
-
SoftLayer_User_Customer_Prospect_Type
-
SoftLayer_User_Customer_Security_Answer
The SoftLayer_User_Customer_Security_Answer type contains user's answers to security questions.
-
SoftLayer_User_Customer_Status
Each SoftLayer User Customer instance is assigned a status code that determines how it's treated in the customer portal. This status is reflected in the SoftLayer_User_Customer_Status data type. Status differs from user permissions in that user status applies globally to the portal while user permissions are applied to specific portal functions.
Note that a status of 'PENDING' also has been added. This status is specific to users that are configured to use IBMid authentication. This would include some (not all) users on accounts that are linked to Platform Services (PaaS, formerly Bluemix) accounts, but is not limited to users in such accounts. Using IBMid authentication is optional for active users even if it is not required by the account type. PENDING status indicates that a relationship between an IBMid and a user is being set up but is not complete. To be complete, PENDING users need to perform an action ('accepting the invitation') before becoming an active user within IBM Cloud and/or IMS. PENDING is a system state, and can not be administered by users (including the account master user). SoftLayer Commercial is the only environment where IBMid and/or account linking are used.
-
SoftLayer_User_Employee
A SoftLayer_User_Employee models a single SoftLayer employee for the purposes of ticket updates created by SoftLayer employees. SoftLayer portal and API users cannot see individual employee names in ticket responses. SoftLayer employees can be assigned to customer accounts as a personal support representative. Employee names and email will be available if an employee is assigned to the account.
-
SoftLayer_User_Employee_Department
SoftLayer_User_Employee_Department models a department within SoftLayer's internal employee hierarchy. Common departments include Support, Sales, Accounting, Development, Systems, and Networking.
-
SoftLayer_User_External_Binding
The SoftLayer_User_External_Binding data type contains general information for a single external binding. This includes the 3rd party vendor, type of binding, and a unique identifier and password that is used to authenticate against the 3rd party service.
-
SoftLayer_User_External_Binding_Attribute
The SoftLayer_User_External_Binding_Attribute data type contains the value for a single attribute associated with an external binding. External binding attributes contain additional information about an external binding. An attribute can be generic or specific to a 3rd party vendor. For example these attributes relate to Verisign: *Credential Type *Credential State *Credential Expiration Date *Credential Last Update Date
-
SoftLayer_User_External_Binding_Type
The SoftLayer_User_External_Binding_Type data type contains information relating to a type of external authentication binding. It contains a user friendly name as well as a unique key name.
-
SoftLayer_User_External_Binding_Vendor
The SoftLayer_User_External_Binding_Vendor data type contains information for a single external binding vendor. This information includes a user friendly vendor name, a unique version of the vendor name, and a unique internal identifier that can be used when creating a new external binding.
-
SoftLayer_User_Interface
A SoftLayer_User_Interface represents a generic user instance within the SoftLayer API. The SoftLayer API uses SoftLayer_User_Interfaces in cases where a user object could be one of many types of users. Currently the [SoftLayer_User_Customer](/reference/datatypes/SoftLayer_User_Customer) and [SoftLayer_User_Employee](/reference/datatypes/SoftLayer_User_Employee) classes are abstracted by this type.
-
SoftLayer_User_Permission_Action
The SoftLayer_User_Permission_Action data type contains local attributes to identify and describe the valid actions a customer user can perform within IMS. This includes a name, key name, and description. This data can not be modified by users of IMS.
It also contains relational attributes that indicate which SoftLayer_User_Permission_Group's include the action.
-
SoftLayer_User_Permission_Department
Organization of User Permissions into Departments which can be used for dynamic display in user portals
-
SoftLayer_User_Permission_Group
The SoftLayer_User_Permission_Group data type contains local attributes to identify and describe the permission groups that have been created within IMS. These includes a name, description, and account id. Permission groups are defined specifically for a single [SoftLayer_Account](/reference/datatypes/SoftLayer_Account).
It also contains relational attributes that indicate what SoftLayer_User_Permission_Action objects belong to a particular group, and what SoftLayer_User_Permission_Role objects the group is linked.
-
SoftLayer_User_Permission_Group_Type
These are the attributes which describe a SoftLayer_User_Permission_Group_Type. All SoftLayer_User_Permission_Group objects must be linked to one of these types.
For further information see: [SoftLayer_User_Permission_Group](/reference/datatypes/SoftLayer_User_Permission_Group).
-
SoftLayer_User_Permission_Resource_Type
These are the variables relating to SoftLayer_User_Permission_Resource_Type. Collectively they describe the types of resources which can be linked to [SoftLayer_User_Permission_Group](/reference/datatypes/SoftLayer_User_Permission_Group).
-
SoftLayer_User_Permission_Role
The SoftLayer_User_Permission_Role data type contains local attributes to identify and describe the permission roles that have been created within IMS. These includes a name, description, and account id. Permission groups are defined specifically for a single [SoftLayer_Account](/reference/datatypes/SoftLayer_Account).
It also contains relational attributes that indicate what SoftLayer_User_Permission_Group objects are linked to a particular role, and the SoftLayer_User_Customer objects assigned to the role.
-
SoftLayer_User_Preference
The SoftLayer_User_Preference data type contains a single user preference to a specific preference type.
-
SoftLayer_User_Preference_Type
The SoftLayer_User_Preference_Type data type contains a single preference type including the accepted values.
-
SoftLayer_User_Security_Question
The SoftLayer_User_Security_Question data type contains questions.
-
SoftLayer_Utility_ObjectFilter
-
SoftLayer_Utility_ObjectFilter_Operation
-
SoftLayer_Utility_ObjectFilter_Operation_Option
-
SoftLayer_Vendor_Type
-
SoftLayer_Verify_Api_HttpObj
-
SoftLayer_Verify_Api_HttpsObj
-
SoftLayer_Virtual_BrowserConsoleAccessLog
The SoftLayer_Virtual_BrowserConsoleAccessLog data type presents the data for events associated with accessing a VSIs console via the browser interface.
-
SoftLayer_Virtual_DedicatedHost
This data type presents the structure for a dedicated host. The data type contains relational properties to distinguish a dedicated host and associate an account to it.
-
SoftLayer_Virtual_Disk_Image
The virtual disk image data type presents the structure in which a virtual disk image will be presented.
Virtual block devices are assigned to disk images.
-
SoftLayer_Virtual_Disk_Image_Software
A SoftLayer_Virtual_Disk_Image_Software record connects a computing instance's virtual disk images with software records. This can be useful if a disk image is directly associated with software such as operating systems.
-
SoftLayer_Virtual_Disk_Image_Software_Password
This SoftLayer_Virtual_Disk_Image_Software_Password data type contains a password for a specific virtual disk image software instance.
-
SoftLayer_Virtual_Disk_Image_Type
SoftLayer_Virtual_Disk_Image_Type models the types of virtual disk images available to CloudLayer Computing Instances. Virtual disk image types describe if an image's data is preservable when upgraded, whether a disk contains a suspended virtual image, or if a disk contains crash dump information.
-
SoftLayer_Virtual_Guest
The virtual guest data type presents the structure in which all virtual guests will be presented. Internally, the structure supports various virtualization platforms with no change to external interaction.
A guest, also known as a virtual server, represents an allocation of resources on a virtual host.
-
SoftLayer_Virtual_Guest_Attribute
-
SoftLayer_Virtual_Guest_Attribute_Type
-
SoftLayer_Virtual_Guest_Attribute_UserData
-
SoftLayer_Virtual_Guest_Block_Device
The block device data type presents the structure in which all block devices will be presented. A block device attaches a disk image to a guest. Internally, the structure supports various virtualization platforms with no change to external interaction.
A guest, also known as a virtual server, represents an allocation of resources on a virtual host.
-
SoftLayer_Virtual_Guest_Block_Device_Status
-
SoftLayer_Virtual_Guest_Block_Device_Template
The virtual block device template data type presents the structure in which all archived image templates are presented.
A virtual block device template, also known as a image template, represents the image of a virtual guest instance.
-
SoftLayer_Virtual_Guest_Block_Device_Template_Group
The virtual block device template group data type presents the structure in which a group of archived image templates will be presented. The structure consists of a parent template group which contain multiple child template group objects. Each child template group object represents the image template in a particular location. Unless editing/deleting a specific child template group object, it is best to use the parent object.
A virtual block device template group, also known as an image template group, represents an image of a virtual guest instance.
-
SoftLayer_Virtual_Guest_Block_Device_Template_Group_Accounts
The SoftLayer_Virtual_Guest_Block_Device_Template_Group_Accounts data type represents the SoftLayer customer accounts which have access to provision CloudLayer Computing Instances from an image template group.
All accounts other than the image template group owner have read-only access to that image template group.
It is important to note that this data type should only exist to give accounts access to the parent template group object, not the child. All image template sharing between accounts should occur on the parent object.
-
SoftLayer_Virtual_Guest_Block_Device_Template_Group_Status
The virtual block device template group status data type represents the current status of the image template. Depending upon the status, the image template can be used for provisioning or reloading.
For an operating system reload, the image template will need to have a status of 'Active' or 'Deprecated'. For a provision, the image template will need to have a status of 'Active'
-
SoftLayer_Virtual_Guest_Boot_Parameter
-
SoftLayer_Virtual_Guest_Boot_Parameter_Type
Describes a virtual guest boot parameter. In this the word class is used in the context of arguments sent to cloud computing instances such as single user mode and boot into bash.
-
SoftLayer_Virtual_Guest_Network_Component
The virtual guest network component data type presents the structure in which all computing instance network components are presented. Internally, the structure supports various virtualization platforms with no change to external interaction.
A guest, also known as a virtual server, represents an allocation of resources on a virtual host.
-
SoftLayer_Virtual_Guest_Network_Component_IcpBinding
-
SoftLayer_Virtual_Guest_Network_Component_IpAddress
The SoftLayer_Virtual_Guest_Network_Component_IpAddress data type contains general information relating to the binding of a single network component to a single SoftLayer IP address.
-
SoftLayer_Virtual_Guest_Power_State
The power state class provides a common set of values for which a guest's power state will be presented in the SoftLayer API.
-
SoftLayer_Virtual_Guest_Status
-
SoftLayer_Virtual_Guest_SupplementalCreateObjectOptions
-
SoftLayer_Virtual_Guest_Type
SoftLayer_Virtual_Guest_Type models the type of a [SoftLayer_Virtual_Guest](/reference/datatypes/SoftLayer_Virtual_Guest) (PUBLIC | DEDICATED | PRIVATE)
-
SoftLayer_Virtual_Guest_Vpc_IpAllocation
-
SoftLayer_Virtual_Guest_Vpc_Subnet
-
SoftLayer_Virtual_Host
The virtual host represents the platform on which virtual guests reside. At times a virtual host has no allocations on the physical server, however with many modern platforms it is a virtual machine with small CPU and Memory allocations that runs in the Control Domain.
-
SoftLayer_Virtual_Host_PciDevice
This type represents a PCI device on a host.
-
SoftLayer_Virtual_Network_SecurityGroup_NetworkComponentBinding
The SoftLayer_Virtual_Network_SecurityGroup_NetworkComponentBinding data type contains general information for a single binding. A binding associates a [SoftLayer_Virtual_Guest_Network_Component](/reference/datatypes/SoftLayer_Virtual_Guest_Network_Component) with a [SoftLayer_Network_SecurityGroup](/reference/datatypes/SoftLayer_Network_SecurityGroup).
-
SoftLayer_Virtual_PlacementGroup
This data type presents the structure for a virtual guest placement group. The data type contains relational properties to the virtual guest placement group rule class.
-
SoftLayer_Virtual_PlacementGroup_Rule
This data type presents the structure of a virtual guest placement group rule.
-
SoftLayer_Virtual_ReservedCapacityGroup
This data type presents the structure for a virtual reserved capacity group.
-
SoftLayer_Virtual_ReservedCapacityGroup_Instance
This data type presents the structure for a virtual reserved capacity group instance.
-
SoftLayer_Virtual_Storage_Repository
The SoftLayer_Virtual_Storage_Repository represents a web based storage system that can be accessed through many types of devices, interfaces, and other resources.
-
SoftLayer_Virtual_Storage_Repository_Type
SoftLayer employs many different types of repositories that computing instances use as their storage volume. SoftLayer_Virtual_Storage_Repository_Type models a single storage type. Common types of storage repositories include networked file systems, logical volume management, and local disk volumes for swap and page file management.
-
Sprint_Container_CostRecovery
-
Trellix_Epolicy_Orchestrator_Version51_Agent_Details
The Trellix_Epolicy_Orchestrator_Version51_Agent_Details data type represents a virus scan agent and contains details about its version.
-
Trellix_Epolicy_Orchestrator_Version51_Policy_Object
The Trellix_Epolicy_Orchestrator_Version51_Policy_Object data type represents a virus scan agent and contains details about its version.
-
Trellix_Epolicy_Orchestrator_Version51_Product_Properties
The Trellix_Epolicy_Orchestrator_Version51_Product_Properties data type represents the version of the virus data file