-
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.
-
IntegratedOfferingTeam_Region
This class represents an Integrated Offering Team region.
-
SoftLayer_Account
Every SoftLayer customer has an account which is defined in the SoftLayer_Account service. SoftLayer accounts have users, hardware, and services such as storage and domains associated with them. The SoftLayer_Account service is a convenient way to obtain general information about your SoftLayer account. Use the data returned by these methods with other API services to get more detailed information about your services and to make changes to your servers and services.
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_Address
SoftLayer's address service allows you to access and manage addresses associated with your account.
-
SoftLayer_Account_Address_Type
-
SoftLayer_Account_Affiliation
-
SoftLayer_Account_Agreement
-
SoftLayer_Account_Authentication_Attribute
-
SoftLayer_Account_Authentication_Attribute_Type
-
SoftLayer_Account_Authentication_Saml
-
SoftLayer_Account_Brand_Migration_Request
Retrieve a request to migrate an account to the owned brand. Note that the brand must be configured to allow migrations. The three statuses are 'PENDING', 'COMPLETE', and 'ERROR'. If the request is 'COMPLETE', then the account successfully migrated. If the request is 'PENDING', it will be migrated at the given `migrationDate.` The 'ERROR' status means an error occurred, and more information can be found in the `statusMessage`.
-
SoftLayer_Account_Business_Partner
-
SoftLayer_Account_Contact
-
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_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_Bluemix
-
SoftLayer_Account_Lockdown_Request
This service allows approved brands the ability to disconnect, reconnect, and disable customer accounts under that brand. Brand customers are able to make requests on their customers through an API call to this service.
Disconnecting a customer will disable all hardware resources (servers and virtual machines) via a lockdown event. The customer will continue to have control portal access as well as access to their private ports.
Reconnecting a customer will restore all previously disconnected public access. The original lockdown event will be closed.
Disabling an account is a PERMANENT action. All billable items under the account will be canceled, access to the control portal, all resources, network access and hardware will be permanently disabled and reclaimed.
-
SoftLayer_Account_MasterServiceAgreement
-
SoftLayer_Account_Note
-
SoftLayer_Account_Partner_Referral_Prospect
-
SoftLayer_Account_Password
As a SoftLayer customer accumulates services they may accumulate usernames and passwords to those services. The SoftLayer_Account_Password data type stores a username and password combination for these services that are tied their customer account. This shouldn't be confused with username and password combinations for server-specific services.
For instance, an account's EVault WebCC information is kept in a SoftLayer_Account_Password record, but a server's root or control panel password isn't. Server software specific usernames and passwords are handled by the SoftLayer_Hardware_Software_Password data 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 role. 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
This service provides Internal IBM Proof of Concept account campaign or promotion codes.
-
SoftLayer_Account_ProofOfConcept_Funding_Type
-
SoftLayer_Account_Reports_Request
-
SoftLayer_Account_Shipment
SoftLayer's shipment service allows the user to access information pertaining to a shipment from the user to SoftLayer or from SoftLayer to the user.
-
SoftLayer_Account_Shipment_Item
SoftLayer's shipment item service allows the user to access information pertaining to a shipment's item from the user to SoftLayer or from SoftLayer to the user.
-
SoftLayer_Account_Shipment_Item_Type
-
SoftLayer_Account_Shipment_Resource_Type
-
SoftLayer_Account_Shipment_Status
-
SoftLayer_Account_Shipment_Tracking_Data
SoftLayer's tracking data service allows the user to access and manage tracking information on shipments sent from the user to SoftLayer or from SoftLayer to the user.
-
SoftLayer_Account_Shipment_Type
-
SoftLayer_Account_Status_Change_Reason
Represents a reason for changing the account status.
-
SoftLayer_Auxiliary_Notification_Emergency
The SoftLayer_Auxiliary_Notification_Emergency service is associated with all actions pertaining to the notification system. It can be used to check for current network or service interruptions that effect SoftLayer services.
-
SoftLayer_Auxiliary_Shipping_Courier_Type
-
SoftLayer_Billing_Currency
-
SoftLayer_Billing_Currency_Country
The SoftLayer_Billing_Currency_Country service provides information about what currencies a customer in a specific country is eligible to use.
-
SoftLayer_Billing_Currency_ExchangeRate
-
SoftLayer_Billing_Info
SoftLayer billing info contains company billing information such as the last date a payment was made and the last time any billing information was update. Use the data returned by these methods with other API services to get more detailed information about your billing information.
Due to the sensitivity of your billing information we don't allow changing this data through the API. Please open a sales ticket in our customer portal if you need to change this information.
-
SoftLayer_Billing_Invoice
The SoftLayer_Billing_Invoice service controls the invoices that are created whenever a SoftLayer customer's account balance changes. Invoices exist in the following states: *'''OPEN''': Invoices which have not been paid yet. Invoices are created in the OPEN state. *'''CLOSED''': Invoices that SoftLayer has received payment for. *'''CLOSED_FAILED''': Invoices which were closed but were not paid for. Customers who are terminated for non-payment typically have invoices in this state.
Once an invoice is paid it moves from OPEN to CLOSED state. Invoices are created under varying types, which are defined in the type property of the [SoftLayer_Invoice](/reference/datatypes/SoftLayer_Invoice). Invoices are created under one of the following type categories: *'''NEW''': An invoice for new service. A SoftLayer customer's first invoice is of the NEW type. *'''RECURRING''': Invoices that are generated on a SoftLayer customer's anniversary billing date for monthly services. *'''ONE-TIME-CHARGE''': Invoices that are generated when one-time charges are applied to an account for fees incurred from products or services procured outside of the standard purchasing processes. *'''CREDIT''': Invoices that are generated whenever SoftLayer applies a credit against an account's balance. *'''REFUND''': Account credits that are applied against a customer's account balance along with the receivables on their account. REFUND type invoices are generated whenever a customer receives a service credit on their account balance and has their invoice items changed due to the credit. *'''MANUAL_PAYMENT_CREDIT''': Invoice credits that are generated whenever a customer makes a manual payment.
Invoices are created with contact information duplicated from the [SoftLayer_Account](/reference/datatypes/SoftLayer_Account). We do this in order to maintain a history of an account's contact information as invoices are generated. Likewise each invoice record keeps track of an account's balance as the invoice is opened and closed.
Query the [SoftLayer_Account](/reference/datatypes/SoftLayer_Account) service to get a list of invoices for your account.
-
SoftLayer_Billing_Invoice_Item
Every invoice item is defined in the SoftLayer_Billing_Invoice_Item service. Softlayer billing invoice items have details about the items that reside within an invoice. These items detail, for instance, the recurring and one time charges for each item billed.
-
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_Tax_Status
Invoice tax status allows the SoftLayer system to track the status of an invoice if the related tax is being calculated by a third-party service. This allows us to know when tax has been calculated and applied successfully and when it has not.
-
SoftLayer_Billing_Invoice_Tax_Type
Invoice tax types allows the SoftLayer system to categorize the different strategies we use to calculate the tax for any invoice. There are three basic strategies in our system: don't calculate tax at all, use a basic, location-based set of rules, or offload the tax calculation to a third party that will take all related factors into account.
-
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_Cancellation_Reason
-
SoftLayer_Billing_Item_Cancellation_Reason_Category
-
SoftLayer_Billing_Item_Cancellation_Request
SoftLayer customers can use this API to submit a cancellation request. A single service cancellation can contain multiple cancellation items which contain a billing item.
-
SoftLayer_Billing_Item_Chronicle
-
SoftLayer_Billing_Item_Virtual_DedicatedHost
-
SoftLayer_Billing_Order
The SoftLayer_Billing_Order service controls the orders that are created whenever a SoftLayer customer's places a purchase. Orders exist in several states. The ones of concern are: *'''QUOTE_PENDING''': Orders which have not been paid yet. Orders pending approval from a Softlayer customer.
Once an order is paid it moves from QUOTE_PENDING to PENDING_APPROVAL state.
Orders are created with contact information duplicated from the [SoftLayer_Account](/reference/datatypes/SoftLayer_Account) or by manual entry. We do this in order to maintain a history of an account's contact information as orders are generated.
Query the [SoftLayer_Account](/reference/datatypes/SoftLayer_Account) service to get a list of orders for your account.
-
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
The SoftLayer_Billing_Order_Item datatype provides information regarding a single ordered item. When a server order or any other order is placed, the information about that order is stored as SoftLayer_Billing_Order_items.
This also provides information about software or hardware related to an ordered item,what package the item is in, and all pricing information related to this ordered item.
-
SoftLayer_Billing_Order_Quote
The SoftLayer_Billing_Order_Quote service controls the quoted orders that are created whenever a SoftLayer customer's places a purchase. Quotes exist in several states. The ones of concern are: *'''PENDING''': Quotes which have not been paid yet. Quotes pending approval from a Softlayer customer.
Once an order is placed from a quote it moves from PENDING to EXPIRED state 2 days after its creation and it is removed from the system after 5 days unless otherwise the SoftLayer customer saved the quote.
Quotes could are created with contact information duplicated from the [SoftLayer_Account](/reference/datatypes/SoftLayer_Account) or by manual entry. We do this in order to maintain a history of an account's contact information as quotes are generated.
Query the [SoftLayer_Account](/reference/datatypes/SoftLayer_Account) service to get a list of quotes for your account.
-
SoftLayer_Brand
Every IBM Cloud Infrastructure customer account is associated to a brand.
IBM Cloud Infrastructure customers are unable to change their brand information in the portal or the API.
-
SoftLayer_Brand_Business_Partner
-
SoftLayer_Brand_Restriction_Location_CustomerCountry
The [SoftLayer_Brand_Restriction_Location_CustomerCountry](/reference/datatypes/SoftLayer_Brand_Restriction_Location_CustomerCountry) service 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
-
SoftLayer_Business_Partner_Segment
-
SoftLayer_Catalyst_Company_Type
-
SoftLayer_Catalyst_Enrollment
-
SoftLayer_Compliance_Report_Type
-
SoftLayer_Configuration_Storage_Group_Array_Type
Supported hardware raid modes
-
SoftLayer_Configuration_Template
Configuration template class encapsulated an arbitrary configuration values for various resources.
-
SoftLayer_Configuration_Template_Section
Configuration section allow you to divide a large configuration values into a smaller pieces.
-
SoftLayer_Configuration_Template_Section_Definition
Configuration definition gives you details of the value that you're setting.
-
SoftLayer_Configuration_Template_Section_Definition_Group
Configuration definition groups help categorize definitions.
-
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
SoftLayer_Configuration_Template_Section_Profile help you keep track of custom configuration profiles.
-
SoftLayer_Configuration_Template_Section_Reference
Configuration section reference allow you to reuse a configuration section from another configuration template.
-
SoftLayer_Configuration_Template_Section_Type
Configuration section type
-
SoftLayer_Configuration_Template_Type
SoftLayer_Configuration_Template_Type defines the types of configuration template.
Template types can be custom, default and so on.
-
SoftLayer_Dns_Domain
SoftLayer customers have the option of hosting DNS domains on the SoftLayer name servers. Individual domains hosted on the SoftLayer name servers are handled through the SoftLayer_Dns_Domain service.
Domain changes are applied automatically by our nameservers, but changes may not be received by the other name servers on the Internet for 72 hours after your change. The SoftLayer_Dns_Domain service does not apply to customers who run their own nameservers on servers purchased from SoftLayer.
SoftLayer provides secondary DNS hosting services if you wish to maintain DNS records on your name server, but have records replicated on SoftLayer's name servers. Use the [SoftLayer_Dns_Secondary](/reference/datatypes/SoftLayer_Dns_Secondary) service to manage secondary DNS zones and transfers.
-
SoftLayer_Dns_Domain_ResourceRecord
Every domain record hosted on the SoftLayer name servers is comprised of a series or resource records that control how the domain operates, translates host names, and translates service location. Each of those resource records is controlled by the SoftLayer_Dns_Domain_ResourceRecord service. SoftLayer domains have the following resource records: * A single SOA record * A records * AAAA records * Optional CNAME records * At least one MX record * NS records for ns1.softlayer.com and ns2.softlayer.com * Optional TXT records * Optional SPF records
The SoftLayer_Dns_Domain_ResourceRecords service also controls the records contained in reverse DNS records. SoftLayer_Dns_Domain_Reverse records contain multiple PTR type resource records.
As with domain changes, resource record changes happen immediately, but may take up to 72 hours to propagate to the rest of the Internet's name servers. The SoftLayer_Dns_Domain_ResourceRecord service only applies to domains hosted on the SoftLayer name servers.
-
SoftLayer_Dns_Domain_ResourceRecord_MxType
The SoftLayer_Dns_Domain_ResourceRecord_MxType service controls the creation, modification, and deletion of MX records within a domain hosted on SoftLayer's DNS servers. It exists separately from the SoftLayer_Dns_Domain_ResourceRecord to provide control for MX priority in addition to host, data, and time-to-live.
-
SoftLayer_Dns_Domain_ResourceRecord_SrvType
The SoftLayer_Dns_Domain_ResourceRecord_SrvType service controls the creation, modification, and deletion of SRV records within a domain hosted on SoftLayer's DNS servers. It exists separately from the SoftLayer_Dns_Domain_ResourceRecord to provide control for SRV priority, port, protocol, service, and weight in addition to host, data, and time-to-live.
-
SoftLayer_Dns_Secondary
SoftLayer's secondary DNS service allows you to use SoftLayer's name servers as a secondary server to your domain's name servers. This is accomplished through the use of zone transfers. Each record created within the secondary DNS service defines which zone is transferred, what server it is transferred from, and the frequency that zone transfers occur at. Zone transfers are performed automatically based on the transfer frequency set on the secondary DNS record. Domains created via zone transfer may not be modified by the SoftLayer portal or API.
The secondary DNS service also provides the ability to manually initiate a zone transfer through the [SoftLayer_Dns_Secondary::transferNow](/reference/datatypes/$1/#$2) method. The daemon that performs zone transfers runs once a minute, therefore it could take a full minute for the zone transfer to be completed.
Secondary DNS transfers may periodically generate notification or error messages. Please use the [SoftLayer_Dns_Message](/reference/datatypes/SoftLayer_Dns_Message) service to retrieve these notifications.
-
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_Event_Log
Event Log service lets you find interesting events related to various SoftLayer products and services such as hardware, virtual server or DNS.
-
SoftLayer_Exception_Brand_Creation
-
SoftLayer_FlexibleCredit_Program
-
SoftLayer_Hardware
Every SoftLayer hardware is defined in the SoftLayer_Hardware service. SoftLayer hardware has network components, software, monitoring services such as network monitoring, and hardware components such as hard drives. The SoftLayer_Hardware service is a convenient way to obtain general information about your SoftLayer hardware. Use the data returned by these methods with other API services to get more detailed information about your services and to make changes to your servers and services.
-
SoftLayer_Hardware_Benchmark_Certification
This certification is used to indicate the date, time and validity of the benchmark certification process. The certification process includes running a battery of tests on all major sub-systems of a server in order to verify that all components of the server are functioning up to specification. Only after a server has passed each and every hardware and configuration test will it be provisioned for a customer. The 'SoftLayer_Hardware_Benchmark_Certification' class is used to indicate the date, time and validity of the benchmark certification process. This process includes running a battery of tests on all major sub-systems of a server to verify that all components of the server are functioning according to their specifications. Once each server has passed all hardware and configurations tests, it is provisioned to a SoftLayer customer.
-
SoftLayer_Hardware_Blade
The SoftLayer_Hardware_Blade service provides specific information about blade servers.
-
SoftLayer_Hardware_Component_Locator
SoftLayer public API to determine the availability of generic hardware component models at data centers
-
SoftLayer_Hardware_Component_Model
Every hardware component is associated with a model. A hardware component model defines the type of hardware component to which it is associated. The '''SoftLayer_Hardware_Component_Model''' class provides detailed information regarding the hardware component.
-
SoftLayer_Hardware_Component_Partition_OperatingSystem
Every SoftLayer Operating System Partition Template is defined in the '''SoftLayer_Hardware_Component_Partition_OperatingSystem''' service. SoftLayer Operating System Partition Templates indicate which operating system a partition template may be used with to configure a hard drive.
-
SoftLayer_Hardware_Component_Partition_Template
Every SoftLayer Partition Template is defined in the SoftLayer_Hardware_Component_Partition_Template service. The '''SoftLayer_Hardware_Component_Partition_Template''' service defines all SoftLayer Partition Templates that exist. SoftLayer Partition Templates group together several partitions that define a configuration of templates for a particular hard drive.
-
SoftLayer_Hardware_Router
This service provides access to the device responsible for routing a particular SoftLayer Router.
-
SoftLayer_Hardware_SecurityModule
-
SoftLayer_Hardware_SecurityModule750
-
SoftLayer_Hardware_Server
Every SoftLayer server is defined in the SoftLayer_Hardware_Server service. SoftLayer servers have all the functionality of SoftLayer_Hardware with the of server specific data and functionality such as Operating System reload dates and motherboard components. The SoftLayer_Hardware service is a convenient way to obtain general information about your SoftLayer server. Use the data returned by these methods with other API services to get more detailed information about your services and to make changes to your servers and services.
-
SoftLayer_Layout_Container
Layout containers are used in the customization of the Portal 4 customer experience.
A single page in the portal can be thought of as a layout container. The container houses individual [SoftLayer_Layout_Item](/reference/datatypes/SoftLayer_Layout_Item), which are the elements of the page (e.g., Ticket list). Layout containers can be added to [SoftLayer_Layout_Profile](/reference/datatypes/SoftLayer_Layout_Profile), allowing for full customization of the container's related items.
-
SoftLayer_Layout_Item
Layout items are used in the customization of the Portal 4 customer experience.
Each [SoftLayer_Layout_Container](/reference/datatypes/SoftLayer_Layout_Container) in the portal contains one or more layout items. These are used to describe elements such as ticket lists. Layout items typically have [SoftLayer_Layout_Preference](/reference/datatypes/SoftLayer_Layout_Preference), which can be customized once the container is added to a [SoftLayer_Layout_Profile](/reference/datatypes/SoftLayer_Layout_Profile).
-
SoftLayer_Layout_Profile
Layout profiles are the primary object used to tie customized portal experiences to the [SoftLayer_User_Customer](/reference/datatypes/SoftLayer_User_Customer).
In order to take full advantage of the flexible customization of the portal, each user must be given one or more layout profiles. Each layout profile is then assigned one of the [SoftLayer_Layout_Container](/reference/datatypes/SoftLayer_Layout_Container), thereby giving the user all [SoftLayer_Layout_Item](/reference/datatypes/SoftLayer_Layout_Item) and associated [SoftLayer_Layout_Profile_Preferences](/reference/datatypes/SoftLayer_Layout_Profile_Preferences). These default preferences can be modified via the [[SoftLayer_Layout_Profile::modifyPreference()]] method, giving the user their own customized configuration.
-
SoftLayer_Layout_Profile_Containers
-
SoftLayer_Layout_Profile_Customer
-
SoftLayer_Layout_Profile_Preference
The profile preferences are an aggregation of the default preferences and the customized preferences.
For each [SoftLayer_Layout_Profile_Containers](/reference/datatypes/SoftLayer_Layout_Profile_Containers) on a [SoftLayer_Layout_Profile](/reference/datatypes/SoftLayer_Layout_Profile), the [SoftLayer_Layout_Preference](/reference/datatypes/SoftLayer_Layout_Preference) are inherited through the profile preferences. However, any one of these may be overridden through the [[SoftLayer_Layout_Profile::modifyPreference()]] method. Rather than maintaining two different sets of preferences, all preferences are grouped together through the profile preferences, presenting the customized preferences in place of the default preferences they are overriding.
-
SoftLayer_Locale
-
SoftLayer_Locale_Country
This service provides methods to retrieve country locale information.
-
SoftLayer_Locale_Timezone
Each User is assigned a timezone allowing for a precise local timestamp.
-
SoftLayer_Location
The SoftLayer_Location API service queries SoftLayer's location tree to find locations for all softlayer resources including bare metal servers, virtual servers, storage repositories, datacenters, points of presence, and many more.
-
SoftLayer_Location_Datacenter
SoftLayer_Location_Datacenter exposes functionality to access datacenter-specific portions of SoftLayer's backend network. SoftLayer maintains datacenters within it's location hierarchy. Datacenters are located in city locations and each contain server room locations, racks, then slots. Each slot location houses a piece of SoftLayer hardware.
-
SoftLayer_Location_Group
-
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_Reservation
-
SoftLayer_Location_Reservation_Rack
-
SoftLayer_Location_Reservation_Rack_Member
-
SoftLayer_Marketplace_Partner
-
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.
The SoftLayer_Metric_Tracking_Object service contains methods that allow users to retrieve data from these tracking objects in raw and graph form.
-
SoftLayer_Metric_Tracking_Object_Bandwidth_Summary
-
SoftLayer_Monitoring_Robot
DEPRECATED.
-
SoftLayer_Network
Provides services oriented to network-centric discovery and manipulation.
-
SoftLayer_Network_Application_Delivery_Controller
SoftLayer_Network_Application_Delivery_Controller controls a single instance of SoftLayer's application delivery controller offerings. Application delivery controllers are capable of application filtering, layer 4 and layer 7 load balancing, and many other functions. Currently SoftLayer employs them as high power load balancers. Load balancing is accomplished similarly to SoftLayer's other load balancer options, through a collection of virtual IP address interfaces.
Application delivery controllers support an 'advanced' configuration scheme, enabling access directly to the controller's backend management interface. Enable access to this interface via the [SoftLayer_Network_Application_Delivery_Controller::enableAdvancedView](/reference/datatypes/$1/#$2) method in this service. Use the username 'root' and password retrieved from this service along with the management IP address retrieved from this service. Be warned that direct access to the application delivery controller exposes a high degree of functionality. Be careful when directly editing your service to avoid interruption via misconfiguration.
-
SoftLayer_Network_Application_Delivery_Controller_Configuration_History
SoftLayer_Network_Application_Delivery_Controller_Configuration_History provides access to view or delete existing configuration history records. Configuration content may not be viewed as it may contain sensitive information. 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_VirtualIpAddress
-
SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualServer
-
SoftLayer_Network_Bandwidth_Version1_Allotment
Every SoftLayer Bandwidth Pooling, Virtual Datacenter, Virtual Private Rack(VPR) is defined in the SoftLayer_Network_Bandwidth_Version1_Allotment service as an allotment. SoftLayer allotments are a collection of servers that share all of the servers allocated bandwidth together.
Virtual Private Rack Each server is by default a part of your Virtual Private Rack. Bandwidth overages are billed individually per server for all hardware in your Virtual Private Rack. If any one server uses more bandwidth than it is allocated, an overage charge will result.
Bandwidth Pooling Bandwidth Pooling allow you to optimize your bandwidth usage by 'pooling' all of the bandwidth together for servers in a Bandwidth Pooling. Bandwidth overages for servers in a Bandwidth Pooling are summed up as a whole and overages are calculated only if the total bandwidth of all servers exceeds the total allocated bandwidth for all servers.
For example, if you had 5 servers, each with 2000 GB of bandwidth, and one server used 3000 GB of bandwidth while the other used only 1500 GB of bandwidth, you would not be billed for an overage because your total usage would be 9000 GB and your total allocated would be 10000 GB.
-
SoftLayer_Network_Component
-
SoftLayer_Network_Component_Firewall
The SoftLayer_Network_Component_Firewall service accesses general information relating to a single SoftLayer network component firewall. This is the object which ties the running rules to a specific downstream server. The current running rule set can be pulled from this service. 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_Customer_Subnet
DEPRECATED
-
SoftLayer_Network_DirectLink_Location
The SoftLayer_Network_DirectLink_Location service allows users to create, update, delete, get details of a Direct Link location and retrieve all existing details.
-
SoftLayer_Network_DirectLink_Provider
The SoftLayer_Network_DirectLink_Provider service allows users to create, update, delete, get details of a Direct Link provider and retrieve all existing details. Provider like 'Equinix', 'Telestra' etc.
-
SoftLayer_Network_DirectLink_ServiceType
The SoftLayer_Network_DirectLink_ServiceType service allows users to create, update, delete, get details of a Direct Link Service Type and retrieve all existing details. Service Types can be EXCHANGE, NSP, COLO or CONNECT
-
SoftLayer_Network_Firewall_AccessControlList
The SoftLayer_Network_Firewall_AccessControlList service accesses general information relating to a single SoftLayer firewall access control list. This is the object which ties the running rules to a specific context. The current running rule set can be pulled from this service. 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 service accesses general information relating to a single SoftLayer firewall interface. This is the object which ties the firewall context access control list to a firewall. The current running rule set can be pulled from this service. 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 service can be used to retrieve recommended SoftLayer network firewall templates and template rules.
The provided 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_Update_Request
The SoftLayer_Network_Firewall_Update_Request service can be used to create SoftLayer network component firewall rules update requests. Update requests are added to a transaction queue and are typically posted in about 60 seconds. After they are posted, they are listed as current rules via the [[SoftLayer Network Component Firewall]] service. 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
The SoftLayer_Network_Firewall_Update_Request_Rule service accesses 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_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_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_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
-
SoftLayer_Network_LBaaS_L7Member
The SoftLayer_Network_LBaaS_L7Member service allows consumers to manage (backend) members for L7 pools. A load balancer may have one or more L7 backend pools. A member can be added to one or more L7 backend pools. Deleting a backend member from one L7 pool will not remove it from other L7 pools to which it is associated. Weight of the backend member is a value between 1 and 256 but only applicable when the load balancing method configured is 'Weighted Round Robin'.
-
SoftLayer_Network_LBaaS_L7Policy
The SoftLayer_Network_LBaaS_L7Policy service allows consumers to manage the Policies associated with a Listener. A Listener can have multiple policies. Polices are associated with priorities. The priorities indicate the order in which policies are evaluated. Each policy is configured with an action which is applied when http traffic matches rules associated with the policy. A policy can be configured with one of the following actions: redirect to pool, redirect to url, or reject. Policies configured with reject are always evaluated first irrespective of the priority followed by redirect to url, after which policies with action set to redirect to pool are evaluated. if policies are configured with redirect to https and reject also, then reject always evaluated first. Polices have multiple rules, each rule is evaluated to true or false. If all the rules of the policy evaluate to true then the action associated with that policy is applied to the request.
-
SoftLayer_Network_LBaaS_L7Pool
-
SoftLayer_Network_LBaaS_L7Rule
The SoftLayer_Network_LBaaS_L7Rule service allows consumers to manage the Rules associated with a Policy.Polices have multiple rules, each rule is evaluated to true or false. If all the rules of the policies are evaluated to true then action of that policy will be applied to the request. Rules have types, which can be HOST_NAME, FILE_TYPE, HEADER, COOKIE, PATH and rules also have a comparison type which indicates how how rules are evaluated. Rules can have following comparison types: REGEX, STARTS_WITH, ENDS_WITH, CONTAINS, and EQUAL_TO.
-
SoftLayer_Network_LBaaS_Listener
The SoftLayer_Network_LBaaS_Listener API service allows consumers to add, edit and delete load balancers protocols for front- and backends. In order to retrieve list of front- and backends protocols please refer to [SoftLayer_Network_LBaaS_LoadBalancer](/reference/datatypes/SoftLayer_Network_LBaaS_LoadBalancer) service. A listener object specifies the protocol and port of allowed incoming network requests and the maximum number of accepted connections. It has references to its associated load balancer and default pool object.
-
SoftLayer_Network_LBaaS_LoadBalancer
The SoftLayer_Network_LBaaS_LoadBalancer service allows customers to create, edit, delete, get details of a load balancer instance and retrieve all existing load balancer instances. The most common use case of a load balancer instance is to improve performance and high availability of customers application services by distributing the incoming requests across multiple servers. Thus, clients using customers application services will only need to know the load balancer instances host name respective IP address in order to submit their requests. Note that SoftLayer_Network_LBaaS_LoadBalancer provides the load balancing functionality only, while it is customers responsibility to implement their application services and deploy them to respective servers, typically virtual servers or bare metal systems hosted by IBM SoftLayer. Conceptually a load balancer instance consists of a set of listeners, also called frontends, pools, also called backends, and members (application servers). A listener (frontend) represents basically the network protocol and port for requests coming from clients applications and is always associated with a pool (backend) defined by a network protocol, port and load balancing algorithm. The pools network protocol and port specify how incoming requests will be forwarded to application servers, while the load balancing algorithm (round-robin, weighted round-robin or least connections) determines the distribution scheme of incoming requests among the members, ie application servers. Note that members of a load balancer instance are assigned implicitly to all pools (backends) of that load balancer.
-
SoftLayer_Network_LBaaS_LoadBalancerAppliance
-
SoftLayer_Network_LBaaS_Member
The SoftLayer_Network_LBaaS_Member service allows consumers to manage (backend) members for a given load balancer. A load balancer may have one or more backend pools. Adding a backend member to the load balancer will add that member to all the backend pools. Similarly, deleting a backend member from the load balancer will remove that member from all associated backend pools. Weight of the backend member is a value between 1 and 256 but only applicable when the load balancing method configured is 'Weighted Round Robin'.
-
SoftLayer_Network_LBaaS_SSLCipher
-
SoftLayer_Network_LoadBalancer_Service
Deprecated
-
SoftLayer_Network_LoadBalancer_VirtualIpAddress
Deprecated
-
SoftLayer_Network_Message_Delivery
-
SoftLayer_Network_Message_Delivery_Email_Sendgrid
-
SoftLayer_Network_Monitor
-
SoftLayer_Network_Monitor_Version1_Query_Host
The Query_Host service is the core of the monitoring system. Each instance of this service represents a monitoring instance. Each monitoring instance 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.
The monitoring services are scheduled jobs, and cannot be initiated by the user. Simply creating the object is enough, the monitor will begin working in 5-10 minutes. Deleting a monitor will immediately remove it from the monitoring queue. Modifications will take effect in 5-10 minutes.
If the user wishes to be notified, or have other users on the account notified when a monitoring instance fails, a response type that includes 'notify users' must be included on the query host object, and a SoftLayer_User_Customer_Notification_Hardware instance must be saved linking the desired users to the hardware being monitored. In order for users to be notified, a SoftLayer_User_Customer_Notification_Hardware object MUST exist linking them to a hardware object, and a monitoring instance on that hardware object must be set to 'notify users'
-
SoftLayer_Network_Monitor_Version1_Query_Host_Stratum
This service is for reference only. It can be changed by purchasing higher monitoring levels through the portal.
-
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_Security_Scanner_Request
DEPRECATED
-
SoftLayer_Network_SecurityGroup
The Security Group service provides a common interface to interact with an account's security groups, their rules, and virtual guest instances associated with the groups. A security group contains a set of IP filter rules that define how to handle incoming (ingress) and outgoing (egress) traffic to both the public and private interfaces of a virtual server instance. The rules that you add to a security group are known as [SoftLayer_Network_SecurityGroup_Rule](/reference/datatypes/SoftLayer_Network_SecurityGroup_Rule). Security groups can be assigned to one or more virtual servers by attaching virtual guest network components through [SoftLayer_Virtual_Network_SecurityGroup_NetworkComponentBinding](/reference/datatypes/SoftLayer_Virtual_Network_SecurityGroup_NetworkComponentBinding).
Additional information can be found in IBM Cloud Docs and SoftLayer API Examples https://console.bluemix.net/docs/infrastructure/security-groups/sg_index.html https://softlayer.github.io/classes/softlayer_network_securitygroup/
-
SoftLayer_Network_Service_Vpn_Overrides
Use to manually decide which subnets within your virtual private address space a SoftLayer portal VPN user may access. Stores a 'white list' consisting of a collection of subnet ids matched up against user ids. This class will reject any subnets or users, that don't belong to the account holder. Note that simply assigning overrides to a user does not enforce the rule change. You must set the manual override flag for the VPN user in the SoftLayer_User_Customer class. It is recommended that before you create new VPN subnet overrides, you delete any old ones for a user, since the VPN authentication system limits the number of accessible subnets by a single user to sixty four. This holds true regardless of whether the VPN user accesses the network via SSL or PPTP. After making any changes to a user's VPN settings, you should call SoftLayer_User_Customer::updateVpnUser() on that customer object.
-
SoftLayer_Network_Storage
SoftLayer customers may have a Storage volume associated with their account. Storage types include NAS, Lockbox, iSCSI, EVault backup, and Hub cloud storage. Information such as the account the Storage volume is associated to, username and password to access the Storage volume, related server (EVault only) and the capacity used are some of the details that may be retrieved using this service. Information regarding the Storage's resource that is useful in reconfiguring and mounting a StorageLayer volume may also be retrieved from this service.
For the EVault Storage services, the username and passwords in the SoftLayer_Network_Storage services are used to register the EVault server agent with the vault. Please see the [SoftLayer_Account_Password](/reference/datatypes/SoftLayer_Account_Password) service to edit the passwords and notes for the EVault Webcc tool.
-
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_Evault
SoftLayer provides the EVault backup system as a part of it's Storage service offerings. EVault is an incremental and automated backup solution with Windows and web-based management clients. The SoftLayer_Network_Storage_Backup_Evault service allows portal and API users to work with their EVault accounts. The large majority of EVault functionality is implemented in the SoftLayer_Network_Storage_Backup_Evault_Version6 service.
-
SoftLayer_Network_Storage_DedicatedCluster
-
SoftLayer_Network_Storage_Group
-
SoftLayer_Network_Storage_Group_Iscsi
-
SoftLayer_Network_Storage_Group_Nfs
-
SoftLayer_Network_Storage_Group_Type
-
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_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_Iscsi
SoftLayer's iscsi product extends upon the base functionality of SoftLayer offerings by providing snapshot and replication capabilities. An iscsi volume is mounted through SoftLayer's private network and allows for block level additional storage on a highly redundant disk array. SoftLayer's iscsi offering is capable of taking volume snapshots which can be mounted read-only or used for an immediate volume data restore. This high-end Storage offering is also capable of being configured for remote data replication to any of SoftLayer's datacenters to provide a solid disaster recovery solution.
-
SoftLayer_Network_Storage_Iscsi_OS_Type
-
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.
The schedule service can be used to create, edit, or delete a schedule. Schedules are defined by the properties associated with them to specify values such as the start date, interval, or end date of the schedule.
-
SoftLayer_Network_Storage_Schedule_Property_Type
-
SoftLayer_Network_Subnet
This service enables interaction with subnets assigned to your account. IP addresses used on your network are drawn from your assigned subnets.
Primary subnets are assigned as needed and are reclaimed when no longer in use. Primary IP addresses assigned to your devices are drawn from your primary subnets, and the consumption of these IP addresses is tracked and discoverable herein.
Secondary subnets are assigned when ordered and are reclaimed when canceled. The consumption of IP addresses is not tracked.
Both IPv4 and IPv6 subnets are supported via this service.
Subnets can be tagged for discoverability and tracking purposes.
-
SoftLayer_Network_Subnet_IpAddress
Every SoftLayer IP address is defined in the SoftLayer_Network_Subnet_IpAddress service. SoftLayer IP addresses are assigned to a SoftLayer_Network_Subnet. The SoftLayer_Network_Subnet_IpAddress service gives you information about an IP address such if it is reserved, a network address, or a gateway. Use the data returned by these methods with other API services to get more detailed information about your services.
SoftLayer customers can order and manage IP addresses through the customer portal. If you need to cancel a subnet please open a sales ticket in our customer portal and our account management staff will assist you.
-
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_Tunnel_Module_Context
DEPRECATED
-
SoftLayer_Network_Vlan
This service enables interaction with VLANs assigned to your account.
Automatic VLANs are assigned as needed and are reclaimed when no longer in use.
Premium VLANs are assigned when ordered and are reclaimed when cancelled.
VLANs can be tagged for discoverability and tracking purposes.
Refer to the following services and methods for related concepts and actions involving VLANs.
- [SoftLayer_Network_Pod](/reference/datatypes/SoftLayer_Network_Pod)
- [SoftLayer_Network_Subnet](/reference/datatypes/SoftLayer_Network_Subnet)
- [SoftLayer_Network_Subnet::route](/reference/services/SoftLayer_Network_Subnet/route)
- [SoftLayer_Network_Subnet::clearRoute](/reference/services/SoftLayer_Network_Subnet/clearRoute)
- [SoftLayer_Network_Component::addNetworkVlanTrunks](/reference/services/SoftLayer_Network_Component/addNetworkVlanTrunks)
- [SoftLayer_Network_Component::removeNetworkVlanTrunks](/reference/services/SoftLayer_Network_Component/removeNetworkVlanTrunks)
-
SoftLayer_Network_Vlan_Firewall
The SoftLayer_Network_Vlan_Firewall service accesses general information relating to a single SoftLayer VLAN firewall. This is the object which ties the running rules to a specific downstream server. The current running rule set can be pulled from this service. 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_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
SoftLayer Customers can use this service to view all of the available notifications that can be subscribed to. Some of the notifications are required while others are not.
-
SoftLayer_Notification_Mobile
SoftLayer Customers can use this service to view all of the available mobile notifications that can be subscribed to. No mobile notifications are required.
-
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_User
-
SoftLayer_Notification_User_Subscriber
SoftLayer Customers can subscribe to receive notifications for various notification types. This service also allows you to 'turn on' or 'turn off' notification messages sent to a subscriber for certain notifications.
-
SoftLayer_Notification_User_Subscriber_Billing
SoftLayer Customers can subscribe to receive notifications for various notification types. This service also allows you to 'turn on' or 'turn off' notification messages sent to a subscriber for certain notifications.
-
SoftLayer_Notification_User_Subscriber_Mobile
SoftLayer Customers can subscribe to receive notifications for various notification types. This service also allows you to 'turn on' or 'turn off' notification messages sent to a subscriber for certain notifications.
-
SoftLayer_Notification_User_Subscriber_Preference
-
SoftLayer_Product_Item
Retrieve a product item and its details.
-
SoftLayer_Product_Item_Category
Retrieve the category information for a product item.
-
SoftLayer_Product_Item_Category_Group
Retrieve the category group information for a product item.
-
SoftLayer_Product_Item_Policy_Assignment
Serves as a data source for additional information about the policy to product assignment.
-
SoftLayer_Product_Item_Price
The SoftLayer_Product_Item_Price 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_Premium
-
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
Every SoftLayer_Product_Package contains information related products and services that SoftLayer sells. The configuration of this package reveals which categories are required to place an order for this package. Every package has items, item prices, locations, regions, and a configuration. This service is the starting point for ordering servers, and other services we provide.
-
SoftLayer_Product_Package_Preset
-
SoftLayer_Product_Package_Server
-
SoftLayer_Product_Package_Server_Option
-
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. To find all the available types, call `getAllObjects` on this class.
-
SoftLayer_Product_Promotion
The promotion web service is used to find information regarding a specific promotion using a promotion code.
-
SoftLayer_Product_Upgrade_Request
SoftLayer_Product_Upgrade_Request tracks the progress of an upgrade, and allows modification of the maintenance window and other information.
-
SoftLayer_Provisioning_Hook
-
SoftLayer_Provisioning_Hook_Type
-
SoftLayer_Provisioning_Maintenance_Classification
The SoftLayer_Provisioning_Maintenance_Classification service returns available maintenance classifications.
-
SoftLayer_Provisioning_Maintenance_Classification_Item_Category
-
SoftLayer_Provisioning_Maintenance_Slots
The SoftLayer_Provisioning_Maintenance_Slots service returns available maintenance slots at SoftLayer data centers.
-
SoftLayer_Provisioning_Maintenance_Ticket
-
SoftLayer_Provisioning_Maintenance_Window
The SoftLayer_Provisioning_Maintenance_Window service returns available maintenance windows at SoftLayer data centers.
-
SoftLayer_Provisioning_Version1_Transaction_Group
The service lists the different types of transactions. This includes operating system reloads and new operating system provisions.
-
SoftLayer_Provisioning_Version1_Transaction_OrderTracking
Provisioning Order Tracking
-
SoftLayer_Provisioning_Version1_Transaction_OrderTrackingState
Provisioning Order Tracking
-
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
DEPRECATED
-
SoftLayer_Resource_Group_Template
-
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
Presale events are related to datacenters or products that are not yet currently available, but will be in the near future. For example, if a new datacenter is opening in a month, a presale event may be created that allows customers to purchase server space in advance. When a presale order is placed, the server configuration is saved, but not provisioned until the presale end date - the server will not be available during this waiting period. Also, when a presale order is placed, the customer is not charged up front, but only when the presale order is actually approved and provisioned on the presale end date.
This server allows customer to view the currently-active presale events and their date ranges. This may allow a customer to plan early for purchasing a new product or server in a new datacenter.
-
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_Request
SoftLayer_Security_Certificate_Request holds your SSL certificate request data. This data is used to manage your SSL certificate order with a Certificate Authority.
To create an SSL certificate order, pass a completed SoftLayer_Container_Product_Order_Security_Certificate to SoftLayer_Product_Order::placeOrder.
-
SoftLayer_Security_Certificate_Request_ServerType
Allows for retrieving the available SSL certificate server types.
-
SoftLayer_Security_Certificate_Request_Status
SoftLayer_Security_Certificate_Request_Status indicates the status of your SSL certificate request. When you submit an SSL certificate order, the associated certificate request will be in the 'Pending CA Approval' status. This is the only status in which can cancel your order.
Once the certificate authority (CA) approves your order, the status will change to 'Approved'. Once your order is approved, you will receive your fulfillment email from the CA. The email will contain your SSL certificate. SoftLayer does not store your SSL certificate in our system. If you lose the email from your CA, you can have the fulfillment email sent again via the SoftLayer customer portal or by using [SoftLayer_Security_Certificate_Request::resendEmail](/reference/services/SoftLayer_Security_Certificate_Request/resendEmail). Your approved order will be picked up by SoftLayer's billing system and it will complete the payment process. Finally, your order will change to 'Complete' status when the payment process is successful.
There might be a chance that your SSL certificate order could rejected by a CA. Our automated system will put a rejected order into 'Canceled' status. You can contact SoftLayer Support for more details.
-
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 the application class that handles a special type of Software License. Most software licenses are licensed to a specific hardware ID or IP address, this is tied to an account.
-
SoftLayer_Software_Component
Every installed piece of software is represented in the API as a 'Software Component.' This is the base class for software components, exposing basic functionality for software components. From any Software Component, through this service, you can get the hardware a component is installed upon, the license that this component is governed by, the current access passwords for a component, and the history of previous passwords for a component.
-
SoftLayer_Software_Component_AntivirusSpyware
This object specifies a specific type of Software Component: An Anti-virus/spyware instance.
-
SoftLayer_Software_Component_HostIps
This service specifies a specific type of Software Component: A Host Intrusion Protection System instance.
-
SoftLayer_Software_Component_Password
The software component password service represents the passwords for a software component, such as an operating system or a control panel. Updating the passwords here will NOT update them on the server itself.
-
SoftLayer_Software_Component_Trellix
This object specifies a specific type of Software Component: An Trellix instance.
-
SoftLayer_Software_Description
-
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_Software_VirtualLicense's service allows you to retrieve the hard-copy license file for a virtual license, if one exists for your license instance.
You can also retrieve the subnet that the IP to which a software virtual license is licensed upon exists in, as well as the software description that this virtual license is for.
-
SoftLayer_Survey
Every SoftLayer survey is defined in the SoftLayer_Survey service. Softlayer survey's have questions and answers from SoftLayer users.
-
SoftLayer_Tag
SoftLayer's tagging service gives customers the ability to tag devices with keywords that can later be used to search upon.
-
SoftLayer_Ticket
Tickets are SoftLayer's primary way to keep in touch with its customers. A ticket is an entity that describes a problem or request and tracks a conversation between you, your account users, and SoftLayer employees relating to your problem or request. Tickets can be assigned to one of your account users, and SoftLayer can assign a ticket to a particular department (also called a ticket group) or employee. The SoftLayer_Ticket service controls your interaction with SoftLayer's ticketing system.
Every ticket object has at least one ticket update. Ticket updates may be created by either a user or SoftLayer employee. These ticket updates record the conversation between SoftLayer and you about the issue at hand. You may only add new updates to a ticket. Once an update is created you may not edit or delete it.
Tickets exist in one of three states: open, assigned, and closed. Open tickets are considered a current issue, but are not yet assigned to a specific SoftLayer employee. Assigned issues are open issues that are assigned to a SoftLayer employee. You can safely assume that your ticket is being handled if it is in the Assigned state. Closed tickets are considered resolved issues and allow no further updates. Please contact SoftLayer if you need to re-open a ticket, as you may only create ticket updates on open or assigned tickets.
It is possible to attach files and associate hardware with a ticket. Associating your ticket with more than one pieces of hardware helps SoftLayer's support team localize issues to certain servers. Attachments are a good way to illustrate a point, such as adding a screen shot of a problem or attaching a driver or configuration file that you'd like investigated.
Typically the only tickets an account user may create are technical support tickets. Technical support tickets are divided into two categories: standard tickets and administrative tickets. A standard support ticket describes an issue with your SoftLayer server or services. Standard support tickets' titles must be selected from a pre-determined list of ticket subjects, defined in the [SoftLayer_Ticket_Subject](/reference/datatypes/SoftLayer_Ticket_Subject) service. If you need a little help from SoftLayer's support staff to manage your server then open an administrative support ticket. Administrative tickets add a one-time $3USD charge to your account, and you may specify your ticket's title as needed.
-
SoftLayer_Ticket_Attachment_File
-
SoftLayer_Ticket_Attachment_File_ServiceNow
-
SoftLayer_Ticket_Priority
-
SoftLayer_Ticket_Subject
Every standard support ticket submitted to SoftLayer contains a relationship to a pre-determined subject which populates that ticket's title. The SoftLayer_Ticket_Subject service retrieves these subjects. These ticket subjects also determine which department a ticket is opened for.
-
SoftLayer_Ticket_Subject_Category
-
SoftLayer_Ticket_Survey
-
SoftLayer_Ticket_Update_Employee
Retrieve an update to a ticket made by a SoftLayer employee. Ticket updates created by employees have the option of being rated on a one to five scale. Because customer updates don't have this ability the SoftLayer_Ticket_Update_Employee class has it's own service.
-
SoftLayer_User_Customer
Every SoftLayer account has one or more portal users which are defined by the SoftLayer_User_Customer service. Every SoftLayer customer account has a master user account whose name corresponds to their account id preceded by the letters 'SL'. Users exist in a parent-child relationship. Child users inherit the properties and permissions of their parent user while conversely a user may have more than one child users.
API users have full access to their own portal user account and they could also have access to other users under their SoftLayer customer account, if they have 'Manage Users' permission in the customer portal.
There are two relational properties that contain the permissions assigned to a customer user; permissions and actions. These are simply two different representations of the same information. The permissions ORM key creates a SoftLayer_Container_Collection_Permissions collection from SoftLayer_User_Customer_CustomerPermission_Permission objects which is populated from the same data source as the actions ORM key which creates a SoftLayer_Container_Collection_Permissions collection from SoftLayer_User_Permission_Action objects.
-
SoftLayer_User_Customer_ApiAuthentication
An account's user may obtain access to SoftLayer's API through this authentication service.
-
SoftLayer_User_Customer_CustomerPermission_Permission
Portal account users who are not the master user (account owner) have permissions to allow them access to portal functionalities.
-
SoftLayer_User_Customer_External_Binding
<<<
-
SoftLayer_User_Customer_External_Binding_Totp
SoftLayer provides its customers the ability to add an additional layer of security to the SoftLayer customer portal by requiring that a user login and authenticate with a trusted 3rd party before they are given access to their SoftLayer account. This is accomplished by creating an external binding for a specific vendor, in this case Time-based One Time Password. When the SoftLayer user attempts to log in to the SoftLayer customer portal they will first be prompted for their normal SoftLayer username and password. Once that information is verified they will be asked to generate and provide a security code from their Time-based One Time Password application. Once the security code has been authenticated the user will be allowed access to the SoftLayer customer portal.
The time-based one time password external binding service allows a user to create an external binding, enable, disable, and delete an external binding.
Once a SoftLayer user has a valid and active time-based one time password external binding, they will be required to always use their credential to login to the SoftLayer customer portal. In addition any user with an active external binding will be prohibited from using the API.
-
SoftLayer_User_Customer_External_Binding_Vendor
The SoftLayer_User_Customer_External_Binding_Vendor service is used to retrieve a list of available 3rd party vendors that SoftLayer supports for external bindings.
-
SoftLayer_User_Customer_External_Binding_Verisign
SoftLayer provides its customers the ability to add an additional layer of security to the SoftLayer customer portal by requiring that a user login and authenticate with a trusted 3rd party before they are given access to their SoftLayer account. This is accomplished by creating an external binding for a specific vendor, in this case VeriSign. When the SoftLayer user attempts to log in to the SoftLayer customer portal they will first be prompted for their normal SoftLayer username and password. Once that information is verified they will be asked to generate and provide a security code from their VeriSign credential. Once the security code has been authenticated with VeriSign the user will be allowed access to the SoftLayer customer portal.
The VeriSign external binding service allows a user to create an external binding, enable, disable, or unlock an external binding, and delete an external binding. Currently SoftLayer provides the master account user of a SoftLayer account with one free VeriSign external binding. All subsequent VeriSign external bindings will need to be created by placing an order.
Once a SoftLayer user has a valid and active VeriSign external binding, they will be required to always use their credential to login to the SoftLayer customer portal. In addition any user with an active external binding will be prohibited from using the API.
-
SoftLayer_User_Customer_Invitation
-
SoftLayer_User_Customer_Notification_Hardware
This service represents the link between a monitored hardware instance, and a user account.
When a monitoring service on that hardware instance fails and the monitor is set to 'notify users,' any users linked to that hardware instance using this service will be notified of the failure.
-
SoftLayer_User_Customer_Notification_Virtual_Guest
This service represents the link between a monitored guest instance, and a user account.
When a monitoring service on that guest instance fails and the monitor is set to 'notify users,' any users linked to that guest instance using this service will be notified of the failure.
-
SoftLayer_User_Customer_OpenIdConnect
-
SoftLayer_User_Customer_OpenIdConnect_TrustedProfile
-
SoftLayer_User_Customer_Profile_Event_HyperWarp
-
SoftLayer_User_Customer_Prospect_ServiceProvider_EnrollRequest
-
SoftLayer_User_Customer_Security_Answer
An account's user have security answers for secondary security measures. These questions/answers can be found during login and password update. These questions/answers are also needed for password reset.
-
SoftLayer_User_Customer_Status
A User's status. It can be Active, Inactive, Disabled, Delete User, or VPN Only.
-
SoftLayer_User_External_Binding
<<<
-
SoftLayer_User_External_Binding_Vendor
The SoftLayer_User_External_Binding_Vendor service is used to retrieve a list of available 3rd party vendors that SoftLayer supports for external bindings.
-
SoftLayer_User_Permission_Action
The SoftLayer_User_Permission_Action class is one of several classes that make up the customer permission system. The system is a role-based system that includes defined actions which can be grouped together using a SoftLayer_User_Permission_Group. These groups of actions are then used to define roles, and the roles are assigned to users.
When a [SoftLayer_User_Customer](/reference/datatypes/SoftLayer_User_Customer) is created, a SoftLayer_User_Permission_Group and SoftLayer_User_Permission_Role is created specifically for the user with a group type of SYSTEM. When the UI is used to alter the permissions of a customer user, the actions are added or removed from this group. The api can not be used to alter the permissions in this group. If an account wants to create their own unique permission groups and roles, the UI can not be used to manage them.
User Customers can be assigned to multiple roles but it is recommended to either use the UI for managing account users permissions or only use the api. Mixing the two will lead to confusing results as the UI will not show any permissions assigned to a user via a customer created role/group combination.
Proceed with caution.
The SoftLayer_User_Permission_Action class defines the permissions that are required in order for a SoftLayer_User_Customer to perform certain actions within IMS.
See [SoftLayer_User_Permission_Group](/reference/datatypes/SoftLayer_User_Permission_Group) and [SoftLayer_Permission_Role](/reference/datatypes/SoftLayer_Permission_Role) for more details.
-
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 class is one of several classes that make up the customer permission system. It is a role-based system that includes defined actions which can be 'grouped' together using a SoftLayer_User_Permission_Group class. These groups of actions are then used to define roles, and the roles are assigned to users. The SoftLayer_User_Permission_Group is also used to track the resources or account devices to which a user has been granted access. The types of resources that users can be granted access is defined in [SoftLayer_User_Permission_Resource_Type](/reference/datatypes/SoftLayer_User_Permission_Resource_Type).
When a [SoftLayer_User_Customer](/reference/datatypes/SoftLayer_User_Customer) is created, a SoftLayer_User_Permission_Group and SoftLayer_User_Permission_Role is created specifically for the user with a group type of SYSTEM. When the UI is used to alter the permissions of a customer user, the actions are added or removed from this group. The api can not be used to alter the permissions in this group. If an account wants to create their own unique permission groups and roles, the UI can not be used to manage them.
This is also true for device access. Either, the UI can be used to track the devices to which users are granted access which will use the SYSTEM group, or the api can be used, making the UI information inaccurate.
User Customers can be assigned to multiple roles but it is recommended to either use the UI for managing account users permissions or only use the api. Mixing the two will lead to confusing results as the UI will not show any permissions assigned to a user via a customer created role/group combination.
Proceed with caution.
One or more [SoftLayer_User_Permission_Action](/reference/datatypes/SoftLayer_User_Permission_Action) are assigned to one or more SoftLayer_User_Permission_Group Objects. One ore more SoftLayer_User_Permission_Group objects can be linked to a [SoftLayer_User_Permission_Role](/reference/datatypes/SoftLayer_User_Permission_Role). A single SoftLayer_User_Permission_Group object can be linked to multiple SoftLayer_User_Permission_Role objects. The [SoftLayer_User_Permission_Role](/reference/datatypes/SoftLayer_User_Permission_Role) is assigned to one or more [SoftLayer_User_Customer](/reference/datatypes/SoftLayer_User_Customer).
The [SoftLayer_User_Permission_Action](/reference/datatypes/SoftLayer_User_Permission_Action) class defines the permissions that are required in order for a [SoftLayer_User_Customer](/reference/datatypes/SoftLayer_User_Customer) to perform certain actions within IMS.
Resources belonging to the user's account can also be linked to permission groups. See [SoftLayer_User_Permission_Resource_Type](/reference/datatypes/SoftLayer_User_Permission_Resource_Type).
-
SoftLayer_User_Permission_Group_Type
The SoftLayer_User_Permission_Group_Type class is one of several classes that make up the customer permission system. This class defines the valid group types. The SYSTEM group type is reserved for internal use.
It is a role-based system that includes defined actions which can be 'grouped' together using a SoftLayer_User_Permission_Group class. These groups of actions are then used to define roles, and the roles are assigned to users.
When a [SoftLayer_User_Customer](/reference/datatypes/SoftLayer_User_Customer) is created, a SoftLayer_User_Permission_Group and SoftLayer_User_Permission_Role is created specifically for the user with a group type of SYSTEM. When the UI is used to alter the permissions of a customer user, the actions are added or removed from this group. The api can not be used to alter the permissions in this group. If an account wants to create their own unique permission groups and roles, the UI can not be used to manage them.
-
SoftLayer_User_Permission_Resource_Type
The SoftLayer_User_Permission_Resource_Type class is one of several classes that make up the customer permission system. The permission system is used to track the permissions assigned to each customer user. These permissions can also include tracking the devices to which users are granted access.
The SoftLayer_User_Permission_Resource_Type class is used to define the valid types of resources to which users can be granted access. Hardware server is an example of a resource type.
See [SoftLayer_User_Permission_Group](/reference/datatypes/SoftLayer_User_Permission_Group) for more information on tracking device access.
-
SoftLayer_User_Permission_Role
The SoftLayer_User_Permission_Role class is one of several classes that make up the customer permission system. The system is a role-based system that includes defined actions which can be 'grouped' together using a SoftLayer_User_Permission_Group class. These groups of actions are then used to define roles, and the roles are assigned to users.
When a [SoftLayer_User_Customer](/reference/datatypes/SoftLayer_User_Customer) is created, a SoftLayer_User_Permission_Role is created for the user with a group type of SYSTEM. This role is linked to the SYSTEM SoftLayer_User_Permission_Group that was also created specifically for this user. When the UI is used to alter the permissions of a customer user, the actions are added or removed from this group. The api can not be used to alter the permissions in this group. If an account wants to create their own unique permission groups and roles, the UI can not be used to manage them.
User Customers can be assigned to multiple roles but it is recommended to either use the UI for managing account users permissions or only use the api. Mixing the two will lead to confusing results as the UI will not show any permissions assigned to a user via a customer created role/group combination.
Proceed with caution.
One or more [SoftLayer_User_Permission_Action](/reference/datatypes/SoftLayer_User_Permission_Action) are assigned to one or more [SoftLayer_User_Permission_Group](/reference/datatypes/SoftLayer_User_Permission_Group) Objects. One ore more SoftLayer_User_Permission_Group objects can be linked to a [SoftLayer_User_Permission_Role](/reference/datatypes/SoftLayer_User_Permission_Role). A single SoftLayer_User_Permission_Group object can be linked to multiple SoftLayer_User_Permission_Role objects. The SoftLayer_User_Permission_Role is assigned to one or more [SoftLayer_User_Customer](/reference/datatypes/SoftLayer_User_Customer). A single SoftLayer_User_Customer can be assigned to one or more roles.
The SoftLayer_User_Permission_Action class defines the permissions that are required in order for a SoftLayer_User_Customer to perform certain actions within IMS.
-
SoftLayer_User_Security_Question
Every user has an option of a secondary security login feature. This SoftLayer_User_Security_Question service provides a list of security questions.
-
SoftLayer_Verify_Api_HttpObj
-
SoftLayer_Verify_Api_HttpsObj
-
SoftLayer_Virtual_DedicatedHost
SoftLayer_Virtual_DedicatedHost models a single tenant virtual host dedicated to a specific account.
-
SoftLayer_Virtual_Disk_Image
-
SoftLayer_Virtual_Guest
The virtual guest service provides a common interface to any virtualization platform supported by SoftLayer. The interaction with various third party APIs is not needed when implementing this service to administer your guests. The SoftLayer_Virtual_Guest service also controls individual CloudLayer Computing Instances purchased from SoftLayer in a way that is analogous to the [SoftLayer_Hardware_Server](/reference/datatypes/SoftLayer_Hardware_Server) service's control over physical hardware purchased form SoftLayer.
-
SoftLayer_Virtual_Guest_Block_Device_Template_Group
The virtual guest block device template group service provides a common interface to an accounts archived image templates The interaction with various third party APIs is not needed when implementing this service to administer your guests.
-
SoftLayer_Virtual_Guest_Boot_Parameter
-
SoftLayer_Virtual_Guest_Boot_Parameter_Type
-
SoftLayer_Virtual_Guest_Network_Component
The virtual guest network component service provides a common interface to a [SoftLayer_Virtual_Guest](/reference/datatypes/SoftLayer_Virtual_Guest) network component. Interaction with various third party APIs is not needed when implementing this service to administer your computing instances.
-
SoftLayer_Virtual_Host
The virtual host service provides a common interface to any virtualization platform supported by SoftLayer. Interaction with various third party APIs is not needed when implementing this service to administer your hosts.
-
SoftLayer_Virtual_PlacementGroup
SoftLayer_Virtual_PlacementGroup is a collection of virtual guests to be placed relative to each other according to a rule.
-
SoftLayer_Virtual_PlacementGroup_Rule
SoftLayer_Virtual_PlacementGroup_Rule is the placement rule that a virtual guest placement group follows.
-
SoftLayer_Virtual_ReservedCapacityGroup
SoftLayer_Virtual_ReservedCapacityGroup reserves capacity for a group of guests that have not yet been provisioned.
-
SoftLayer_Virtual_ReservedCapacityGroup_Instance
SoftLayer_Virtual_ReservedCapacityGroup_Instance reserves capacity for a single instance of a reserved capacity group.
-
SoftLayer_Virtual_Storage_Repository
Storage Repositories are storage systems that are accessible through the internet and can be accessed through many types of devices, interfaces, and other resources such as NFS (Network File System). They can contain 1 or more [SoftLayer_Virtual_Disk_Image](/reference/datatypes/SoftLayer_Virtual_Disk_Image) and can be attached to more than one [SoftLayer_Virtual_Host](/reference/datatypes/SoftLayer_Virtual_Host).